google-apis-recaptchaenterprise_v1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb8e44da6484c5071c2c52956040de5a20e3e2d172b6140289acbc2ab04612f0
+  data.tar.gz: 67f049173decbfc7dd1d37415998d2ec3958abdf71835c28ed942564d3aa6df4
+SHA512:
+  metadata.gz: 65a7ff53b559e4a67bd5c84c5d3a74fb1a978e2806daa8011fdf5003782b29db33a4d3a88ce2e40643448dfdc42ecf71409dd33a2bc3106818f89f1d7280168e
+  data.tar.gz: b32834db1a3bc5a6c73943bafd07980861227039290c052e9fb1ac04a925015f600e5c8e1217d023692abf9f3d0b9a5e694f74920930b2654119848caa9825ca

data/.yardopts

@@ -0,0 +1,13 @@
+--hide-void-return
+--no-private
+--verbose
+--title=google-apis-recaptchaenterprise_v1
+--markup-provider=redcarpet
+--markup=markdown
+--main OVERVIEW.md
+lib/google/apis/recaptchaenterprise_v1/*.rb
+lib/google/apis/recaptchaenterprise_v1.rb
+-
+OVERVIEW.md
+CHANGELOG.md
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release history for google-apis-recaptchaenterprise_v1
+
+### v0.1.0 (2021-05-11)
+
+* Regenerated from discovery document revision 20210501
+* Regenerated using generator version 0.2.0
+

data/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/OVERVIEW.md

@@ -0,0 +1,96 @@
+# Simple REST client for version V1 of the reCAPTCHA Enterprise API
+
+This is a simple client library for version V1 of the reCAPTCHA Enterprise API. It provides:
+
+* A client object that connects to the HTTP/JSON REST endpoint for the service.
+* Ruby objects for data structures related to the service.
+* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
+* Control of retry, pagination, and timeouts.
+
+Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
+
+## Getting started
+
+### Before you begin
+
+There are a few setup steps you need to complete before you can use this library:
+
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/recaptchaenterprise.googleapis.com) in the console.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-apis-recaptchaenterprise_v1', '~> 0.1'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install google-apis-recaptchaenterprise_v1
+```
+
+### Creating a client object
+
+Once the gem is installed, you can load the client code and instantiate a client.
+
+```ruby
+# Load the client
+require "google/apis/recaptchaenterprise_v1"
+
+# Create a client object
+client = Google::Apis::RecaptchaenterpriseV1::RecaptchaEnterpriseService.new
+
+# Authenticate calls
+client.authentication = # ... use the googleauth gem to create credentials
+```
+
+See the class reference docs for information on the methods you can call from a client.
+
+## Documentation
+
+More detailed descriptions of the Google simple REST clients are available in two documents.
+
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
+ *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
+
+(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Recaptchaenterprise service in particular.)
+
+For reference information on specific calls in the reCAPTCHA Enterprise API, see the {Google::Apis::RecaptchaenterpriseV1::RecaptchaEnterpriseService class reference docs}.
+
+## Which client should I use?
+
+Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
+
+This library, `google-apis-recaptchaenterprise_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
+
+Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
+
+Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
+
+**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
+
+The [product documentation](https://cloud.google.com/recaptcha-enterprise/) may provide guidance regarding the preferred client library to use.
+
+## Supported Ruby versions
+
+This library is supported on Ruby 2.5+.
+
+Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
+
+## Support
+
+Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-apis-recaptchaenterprise_v1.rb

@@ -0,0 +1,15 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/recaptchaenterprise_v1"

data/lib/google/apis/recaptchaenterprise_v1.rb

@@ -0,0 +1,36 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/recaptchaenterprise_v1/service.rb'
+require 'google/apis/recaptchaenterprise_v1/classes.rb'
+require 'google/apis/recaptchaenterprise_v1/representations.rb'
+require 'google/apis/recaptchaenterprise_v1/gem_version.rb'
+
+module Google
+  module Apis
+    # reCAPTCHA Enterprise API
+    #
+    # 
+    #
+    # @see https://cloud.google.com/recaptcha-enterprise/
+    module RecaptchaenterpriseV1
+      # Version of the reCAPTCHA Enterprise API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V1'
+
+      # See, edit, configure, and delete your Google Cloud Platform data
+      AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
+    end
+  end
+end

data/lib/google/apis/recaptchaenterprise_v1/classes.rb

@@ -0,0 +1,586 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module RecaptchaenterpriseV1
+      
+      # Settings specific to keys that can be used by Android apps.
+      class GoogleCloudRecaptchaenterpriseV1AndroidKeySettings
+        include Google::Apis::Core::Hashable
+      
+        # Android package names of apps allowed to use the key. Example: 'com.
+        # companyname.appname'
+        # Corresponds to the JSON property `allowedPackageNames`
+        # @return [Array<String>]
+        attr_accessor :allowed_package_names
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allowed_package_names = args[:allowed_package_names] if args.key?(:allowed_package_names)
+        end
+      end
+      
+      # The request message to annotate an Assessment.
+      class GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest
+        include Google::Apis::Core::Hashable
+      
+        # 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.
+        # Corresponds to the JSON property `annotation`
+        # @return [String]
+        attr_accessor :annotation
+      
+        # Optional. Optional reasons for the annotation that will be assigned to the
+        # Event.
+        # Corresponds to the JSON property `reasons`
+        # @return [Array<String>]
+        attr_accessor :reasons
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @annotation = args[:annotation] if args.key?(:annotation)
+          @reasons = args[:reasons] if args.key?(:reasons)
+        end
+      end
+      
+      # Empty response for AnnotateAssessment.
+      class GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # A recaptcha assessment resource.
+      class GoogleCloudRecaptchaenterpriseV1Assessment
+        include Google::Apis::Core::Hashable
+      
+        # The event being assessed.
+        # Corresponds to the JSON property `event`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Event]
+        attr_accessor :event
+      
+        # Output only. The resource name for the Assessment in the format "projects/`
+        # project`/assessments/`assessment`".
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Risk analysis result for an event.
+        # Corresponds to the JSON property `riskAnalysis`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1RiskAnalysis]
+        attr_accessor :risk_analysis
+      
+        # Output only. Properties of the provided event token.
+        # Corresponds to the JSON property `tokenProperties`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TokenProperties]
+        attr_accessor :token_properties
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @event = args[:event] if args.key?(:event)
+          @name = args[:name] if args.key?(:name)
+          @risk_analysis = args[:risk_analysis] if args.key?(:risk_analysis)
+          @token_properties = args[:token_properties] if args.key?(:token_properties)
+        end
+      end
+      
+      # Metrics related to challenges.
+      class GoogleCloudRecaptchaenterpriseV1ChallengeMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Count of submitted challenge solutions that were incorrect or otherwise deemed
+        # suspicious such that a subsequent challenge was triggered.
+        # Corresponds to the JSON property `failedCount`
+        # @return [Fixnum]
+        attr_accessor :failed_count
+      
+        # Count of nocaptchas (successful verification without a challenge) issued.
+        # Corresponds to the JSON property `nocaptchaCount`
+        # @return [Fixnum]
+        attr_accessor :nocaptcha_count
+      
+        # Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to
+        # a count of pageloads for pages that include reCAPTCHA.
+        # Corresponds to the JSON property `pageloadCount`
+        # @return [Fixnum]
+        attr_accessor :pageload_count
+      
+        # Count of nocaptchas (successful verification without a challenge) plus
+        # submitted challenge solutions that were correct and resulted in verification.
+        # Corresponds to the JSON property `passedCount`
+        # @return [Fixnum]
+        attr_accessor :passed_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @failed_count = args[:failed_count] if args.key?(:failed_count)
+          @nocaptcha_count = args[:nocaptcha_count] if args.key?(:nocaptcha_count)
+          @pageload_count = args[:pageload_count] if args.key?(:pageload_count)
+          @passed_count = args[:passed_count] if args.key?(:passed_count)
+        end
+      end
+      
+      # 
+      class GoogleCloudRecaptchaenterpriseV1Event
+        include Google::Apis::Core::Hashable
+      
+        # 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.
+        # Corresponds to the JSON property `expectedAction`
+        # @return [String]
+        attr_accessor :expected_action
+      
+        # Optional. The site key that was used to invoke reCAPTCHA on your site and
+        # generate the token.
+        # Corresponds to the JSON property `siteKey`
+        # @return [String]
+        attr_accessor :site_key
+      
+        # Optional. The user response token provided by the reCAPTCHA client-side
+        # integration on your site.
+        # Corresponds to the JSON property `token`
+        # @return [String]
+        attr_accessor :token
+      
+        # Optional. The user agent present in the request from the user's device related
+        # to this event.
+        # Corresponds to the JSON property `userAgent`
+        # @return [String]
+        attr_accessor :user_agent
+      
+        # Optional. The IP address in the request from the user's device related to this
+        # event.
+        # Corresponds to the JSON property `userIpAddress`
+        # @return [String]
+        attr_accessor :user_ip_address
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @expected_action = args[:expected_action] if args.key?(:expected_action)
+          @site_key = args[:site_key] if args.key?(:site_key)
+          @token = args[:token] if args.key?(:token)
+          @user_agent = args[:user_agent] if args.key?(:user_agent)
+          @user_ip_address = args[:user_ip_address] if args.key?(:user_ip_address)
+        end
+      end
+      
+      # Settings specific to keys that can be used by iOS apps.
+      class GoogleCloudRecaptchaenterpriseV1IosKeySettings
+        include Google::Apis::Core::Hashable
+      
+        # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.
+        # productname.appname'
+        # Corresponds to the JSON property `allowedBundleIds`
+        # @return [Array<String>]
+        attr_accessor :allowed_bundle_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allowed_bundle_ids = args[:allowed_bundle_ids] if args.key?(:allowed_bundle_ids)
+        end
+      end
+      
+      # A key used to identify and configure applications (web and/or mobile) that use
+      # reCAPTCHA Enterprise.
+      class GoogleCloudRecaptchaenterpriseV1Key
+        include Google::Apis::Core::Hashable
+      
+        # Settings specific to keys that can be used by Android apps.
+        # Corresponds to the JSON property `androidSettings`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1AndroidKeySettings]
+        attr_accessor :android_settings
+      
+        # The timestamp corresponding to the creation of this Key.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Human-readable display name of this key. Modifiable by user.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Settings specific to keys that can be used by iOS apps.
+        # Corresponds to the JSON property `iosSettings`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1IosKeySettings]
+        attr_accessor :ios_settings
+      
+        # See Creating and managing labels.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # The resource name for the Key in the format "projects/`project`/keys/`key`".
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Options for user acceptance testing.
+        # Corresponds to the JSON property `testingOptions`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TestingOptions]
+        attr_accessor :testing_options
+      
+        # Settings specific to keys that can be used by websites.
+        # Corresponds to the JSON property `webSettings`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WebKeySettings]
+        attr_accessor :web_settings
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @android_settings = args[:android_settings] if args.key?(:android_settings)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @ios_settings = args[:ios_settings] if args.key?(:ios_settings)
+          @labels = args[:labels] if args.key?(:labels)
+          @name = args[:name] if args.key?(:name)
+          @testing_options = args[:testing_options] if args.key?(:testing_options)
+          @web_settings = args[:web_settings] if args.key?(:web_settings)
+        end
+      end
+      
+      # Response to request to list keys in a project.
+      class GoogleCloudRecaptchaenterpriseV1ListKeysResponse
+        include Google::Apis::Core::Hashable
+      
+        # Key details.
+        # Corresponds to the JSON property `keys`
+        # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Key>]
+        attr_accessor :keys
+      
+        # Token to retrieve the next page of results. It is set to empty if no keys
+        # remain in results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @keys = args[:keys] if args.key?(:keys)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
+      # Metrics for a single Key.
+      class GoogleCloudRecaptchaenterpriseV1Metrics
+        include Google::Apis::Core::Hashable
+      
+        # Metrics will be continuous and in order by dates, and in the granularity of
+        # day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-
+        # based data.
+        # Corresponds to the JSON property `challengeMetrics`
+        # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ChallengeMetrics>]
+        attr_accessor :challenge_metrics
+      
+        # Metrics will be continuous and in order by dates, and in the granularity of
+        # day. All Key types should have score-based data.
+        # Corresponds to the JSON property `scoreMetrics`
+        # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ScoreMetrics>]
+        attr_accessor :score_metrics
+      
+        # Inclusive start time aligned to a day (UTC).
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @challenge_metrics = args[:challenge_metrics] if args.key?(:challenge_metrics)
+          @score_metrics = args[:score_metrics] if args.key?(:score_metrics)
+          @start_time = args[:start_time] if args.key?(:start_time)
+        end
+      end
+      
+      # The migrate key request message.
+      class GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Risk analysis result for an event.
+      class GoogleCloudRecaptchaenterpriseV1RiskAnalysis
+        include Google::Apis::Core::Hashable
+      
+        # Reasons contributing to the risk analysis verdict.
+        # Corresponds to the JSON property `reasons`
+        # @return [Array<String>]
+        attr_accessor :reasons
+      
+        # Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate
+        # traffic while 0.0 means very likely non-legitimate traffic).
+        # Corresponds to the JSON property `score`
+        # @return [Float]
+        attr_accessor :score
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @reasons = args[:reasons] if args.key?(:reasons)
+          @score = args[:score] if args.key?(:score)
+        end
+      end
+      
+      # Score distribution.
+      class GoogleCloudRecaptchaenterpriseV1ScoreDistribution
+        include Google::Apis::Core::Hashable
+      
+        # Map key is score value multiplied by 100. The scores are discrete values
+        # between [0, 1]. The maximum number of buckets is on order of a few dozen, but
+        # typically much lower (ie. 10).
+        # Corresponds to the JSON property `scoreBuckets`
+        # @return [Hash<String,Fixnum>]
+        attr_accessor :score_buckets
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @score_buckets = args[:score_buckets] if args.key?(:score_buckets)
+        end
+      end
+      
+      # Metrics related to scoring.
+      class GoogleCloudRecaptchaenterpriseV1ScoreMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Action-based metrics. The map key is the action name which specified by the
+        # site owners at time of the "execute" client-side call. Populated only for
+        # SCORE keys.
+        # Corresponds to the JSON property `actionMetrics`
+        # @return [Hash<String,Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ScoreDistribution>]
+        attr_accessor :action_metrics
+      
+        # Score distribution.
+        # Corresponds to the JSON property `overallMetrics`
+        # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ScoreDistribution]
+        attr_accessor :overall_metrics
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @action_metrics = args[:action_metrics] if args.key?(:action_metrics)
+          @overall_metrics = args[:overall_metrics] if args.key?(:overall_metrics)
+        end
+      end
+      
+      # Options for user acceptance testing.
+      class GoogleCloudRecaptchaenterpriseV1TestingOptions
+        include Google::Apis::Core::Hashable
+      
+        # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
+        # for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge
+        # if CHALLENGE.
+        # Corresponds to the JSON property `testingChallenge`
+        # @return [String]
+        attr_accessor :testing_challenge
+      
+        # All assessments for this Key will return this score. Must be between 0 (likely
+        # not legitimate) and 1 (likely legitimate) inclusive.
+        # Corresponds to the JSON property `testingScore`
+        # @return [Float]
+        attr_accessor :testing_score
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @testing_challenge = args[:testing_challenge] if args.key?(:testing_challenge)
+          @testing_score = args[:testing_score] if args.key?(:testing_score)
+        end
+      end
+      
+      # 
+      class GoogleCloudRecaptchaenterpriseV1TokenProperties
+        include Google::Apis::Core::Hashable
+      
+        # Action name provided at token generation.
+        # Corresponds to the JSON property `action`
+        # @return [String]
+        attr_accessor :action
+      
+        # The timestamp corresponding to the generation of the token.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # The hostname of the page on which the token was generated.
+        # Corresponds to the JSON property `hostname`
+        # @return [String]
+        attr_accessor :hostname
+      
+        # Reason associated with the response when valid = false.
+        # Corresponds to the JSON property `invalidReason`
+        # @return [String]
+        attr_accessor :invalid_reason
+      
+        # Whether the provided user response token is valid. When valid = false, the
+        # reason could be specified in invalid_reason or it could also be due to a user
+        # failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to
+        # generate the token was different than the one specified in the assessment).
+        # Corresponds to the JSON property `valid`
+        # @return [Boolean]
+        attr_accessor :valid
+        alias_method :valid?, :valid
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @action = args[:action] if args.key?(:action)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @hostname = args[:hostname] if args.key?(:hostname)
+          @invalid_reason = args[:invalid_reason] if args.key?(:invalid_reason)
+          @valid = args[:valid] if args.key?(:valid)
+        end
+      end
+      
+      # Settings specific to keys that can be used by websites.
+      class GoogleCloudRecaptchaenterpriseV1WebKeySettings
+        include Google::Apis::Core::Hashable
+      
+        # If set to true, it means allowed_domains will not be enforced.
+        # Corresponds to the JSON property `allowAllDomains`
+        # @return [Boolean]
+        attr_accessor :allow_all_domains
+        alias_method :allow_all_domains?, :allow_all_domains
+      
+        # Required. Whether this key can be used on AMP (Accelerated Mobile Pages)
+        # websites. This can only be set for the SCORE integration type.
+        # Corresponds to the JSON property `allowAmpTraffic`
+        # @return [Boolean]
+        attr_accessor :allow_amp_traffic
+        alias_method :allow_amp_traffic?, :allow_amp_traffic
+      
+        # Domains or subdomains of websites allowed to use the key. All subdomains of an
+        # allowed domain are automatically allowed. A valid domain requires a host and
+        # must not include any path, port, query or fragment. Examples: 'example.com' or
+        # 'subdomain.example.com'
+        # Corresponds to the JSON property `allowedDomains`
+        # @return [Array<String>]
+        attr_accessor :allowed_domains
+      
+        # Settings for the frequency and difficulty at which this key triggers captcha
+        # challenges. This should only be specified for IntegrationTypes CHECKBOX and
+        # INVISIBLE.
+        # Corresponds to the JSON property `challengeSecurityPreference`
+        # @return [String]
+        attr_accessor :challenge_security_preference
+      
+        # Required. Describes how this key is integrated with the website.
+        # Corresponds to the JSON property `integrationType`
+        # @return [String]
+        attr_accessor :integration_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allow_all_domains = args[:allow_all_domains] if args.key?(:allow_all_domains)
+          @allow_amp_traffic = args[:allow_amp_traffic] if args.key?(:allow_amp_traffic)
+          @allowed_domains = args[:allowed_domains] if args.key?(:allowed_domains)
+          @challenge_security_preference = args[:challenge_security_preference] if args.key?(:challenge_security_preference)
+          @integration_type = args[:integration_type] if args.key?(:integration_type)
+        end
+      end
+      
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
+      # `Empty` is empty JSON object ````.
+      class GoogleProtobufEmpty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+    end
+  end
+end