google-apis-firebaseappcheck_v1beta 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b277cc22a7a5e38f10ae593366a656a5dbd0acfafca5be1542777283c9705d8
-  data.tar.gz: b1f286b30a62ec1e5743095d4475914d1ae7c86264c2e9fe7567fcfeb5ae3cb6
+  metadata.gz: 720474e11ced7a8c728d9daf6906425027fe185d213e2ad4588b42e68a21ffb5
+  data.tar.gz: 94e31a3e0cc47421ed5c8e64ff9770de121708f0247b492615f88132815c8b9c
 SHA512:
-  metadata.gz: d159bbd586f8425b7987f2a8bb2e7fb66ef5756d94bdf35be3f05210487d42fc1f9e7225342298c4596fdab31c182e834a33759c7f5f3b209d68878ec1279a49
-  data.tar.gz: 5f4cdd0cca7414d40a9f114f6db2664ed09f6e1247846a509576ca09d6a1eaa7feb20e8d4fc917e2e15952a1a584c2cf6aefefb4bcfbb1f48d06ea5fc874c368
+  metadata.gz: 59220e1fa1714d6ba6ee93ca96cfb9ae69e77e8e7bbc045710f9ca9fd5d039904daabc63788ef9212a8de9a624218d1298fefa1568ad2aa1a4a71aa14cb69f88
+  data.tar.gz: d06814c81af8e8c8b72993c17d94073cd9cb0fb7daa9a6ff9e720847cf987561d15db5eb1971c5cb161ab041f6df292269258ba6a0ea6562641d295ae92aae99

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-firebaseappcheck_v1beta
 
+### v0.8.0 (2021-10-20)
+
+* Regenerated from discovery document revision 20211015
+
 ### v0.7.0 (2021-09-29)
 
 * Regenerated from discovery document revision 20210924

data/OVERVIEW.md

@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
 
 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.
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/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/main/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 Firebaseappcheck service in particular.)
 

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

@@ -22,21 +22,19 @@ module Google
   module Apis
     module FirebaseappcheckV1beta
       
-      # Response object for GenerateAppAttestChallenge
+      # Response message for the GenerateAppAttestChallenge method.
       class GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
         include Google::Apis::Core::Hashable
       
-        # A one time use challenge for the client to pass to Apple's App Attest API.
+        # A one-time use challenge for the client to pass to the App Attest API.
         # Corresponds to the JSON property `challenge`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :challenge
       
-        # The duration from the time this challenge is minted until it is expired. This
-        # field is intended to ease client-side token management, since the device may
-        # have clock skew, but is still able to accurately measure a duration. This
-        # expiration is intended to minimize the replay window within which a single
-        # challenge may be reused. See AIP 142 for naming of this field.
+        # The duration from the time this challenge is minted until its expiration. This
+        # field is intended to ease client-side token management, since the client may
+        # have clock skew, but is still able to accurately measure a duration.
         # Corresponds to the JSON property `ttl`
         # @return [String]
         attr_accessor :ttl
@@ -54,11 +52,11 @@ module Google
       
       # An app's App Attest configuration object. This configuration controls certain
       # properties of the App Check token returned by ExchangeAppAttestAttestation and
-      # ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID
-      # registered with your app is used as part of the validation process. Please
-      # register it via the Firebase Console or programmatically via the [Firebase
-      # Management Service](https://firebase.google.com/docs/projects/api/reference/
-      # rest/v1beta1/projects.iosApps/patch).
+      # ExchangeAppAttestAssertion, such as its ttl. Note that the Team ID registered
+      # with your app is used as part of the validation process. Please register it
+      # via the Firebase Console or programmatically via the [Firebase Management
+      # Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/
+      # projects.iosApps/patch).
       class GoogleFirebaseAppcheckV1betaAppAttestConfig
         include Google::Apis::Core::Hashable
       
@@ -252,17 +250,17 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # The relative resource name of the debug token, in the format: ``` projects/`
-        # project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
+        # Required. The relative resource name of the debug token, in the format: ```
+        # projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # Input only. Immutable. The secret token itself. Must be provided during
-        # creation, and must be a UUID4, case insensitive. This field is immutable once
-        # set, and cannot be provided during an UpdateDebugToken request. You can,
-        # however, delete this debug token using DeleteDebugToken to revoke it. For
-        # security reasons, this field will never be populated in any response.
+        # Required. Input only. Immutable. The secret token itself. Must be provided
+        # during creation, and must be a UUID4, case insensitive. This field is
+        # immutable once set, and cannot be provided during an UpdateDebugToken request.
+        # You can, however, delete this debug token using DeleteDebugToken to revoke it.
+        # For security reasons, this field will never be populated in any response.
         # Corresponds to the JSON property `token`
         # @return [String]
         attr_accessor :token
@@ -338,23 +336,26 @@ module Google
         end
       end
       
-      # Request message for ExchangeAppAttestAssertion
+      # Request message for the ExchangeAppAttestAssertion method.
       class GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest
         include Google::Apis::Core::Hashable
       
-        # The artifact previously returned by ExchangeAppAttestAttestation.
+        # Required. The artifact returned by a previous call to
+        # ExchangeAppAttestAttestation.
         # Corresponds to the JSON property `artifact`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :artifact
       
-        # The CBOR encoded assertion provided by the Apple App Attest SDK.
+        # Required. The CBOR-encoded assertion returned by the client-side App Attest
+        # API.
         # Corresponds to the JSON property `assertion`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :assertion
       
-        # A one time challenge returned by GenerateAppAttestChallenge.
+        # Required. A one-time challenge returned by an immediately prior call to
+        # GenerateAppAttestChallenge.
         # Corresponds to the JSON property `challenge`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -372,19 +373,19 @@ module Google
         end
       end
       
-      # Request message for ExchangeAppAttestAttestation
+      # Request message for the ExchangeAppAttestAttestation method.
       class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest
         include Google::Apis::Core::Hashable
       
-        # Required. The App Attest statement as returned by Apple's client-side App
-        # Attest API. This is the CBOR object returned by Apple, which will be Base64
-        # encoded in the JSON API.
+        # Required. The App Attest statement returned by the client-side App Attest API.
+        # This is a base64url encoded CBOR object in the JSON response.
         # Corresponds to the JSON property `attestationStatement`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :attestation_statement
       
-        # Required. The challenge previously generated by the FAC backend.
+        # Required. A one-time challenge returned by an immediately prior call to
+        # GenerateAppAttestChallenge.
         # Corresponds to the JSON property `challenge`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -408,12 +409,11 @@ module Google
         end
       end
       
-      # Response message for ExchangeAppAttestAttestation and
-      # ExchangeAppAttestDebugAttestation
+      # Response message for the ExchangeAppAttestAttestation method.
       class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
         include Google::Apis::Core::Hashable
       
-        # An artifact that should be passed back during the Assertion flow.
+        # An artifact that can be used in future calls to ExchangeAppAttestAssertion.
         # Corresponds to the JSON property `artifact`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -482,7 +482,7 @@ module Google
       
         # Required. The `device_token` as returned by Apple's client-side [DeviceCheck
         # API](https://developer.apple.com/documentation/devicecheck/dcdevice). This is
-        # the Base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
+        # the base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
         # Corresponds to the JSON property `deviceToken`
         # @return [String]
         attr_accessor :device_token
@@ -537,7 +537,7 @@ module Google
         end
       end
       
-      # Request message for GenerateAppAttestChallenge
+      # Request message for the GenerateAppAttestChallenge method.
       class GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest
         include Google::Apis::Core::Hashable
       
@@ -664,7 +664,7 @@ module Google
       # The currently active set of public keys that can be used to verify App Check
       # tokens. This object is a JWK set as specified by [section 5 of RFC 7517](https:
       # //tools.ietf.org/html/rfc7517#section-5). For security, the response **must
-      # not** be cached for longer than one day.
+      # not** be cached for longer than six hours.
       class GoogleFirebaseAppcheckV1betaPublicJwkSet
         include Google::Apis::Core::Hashable
       

data/lib/google/apis/firebaseappcheck_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirebaseappcheckV1beta
       # Version of the google-apis-firebaseappcheck_v1beta gem
-      GEM_VERSION = "0.7.0"
+      GEM_VERSION = "0.8.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210924"
+      REVISION = "20211015"
     end
   end
 end

data/lib/google/apis/firebaseappcheck_v1beta/service.rb

@@ -22,18 +22,8 @@ module Google
     module FirebaseappcheckV1beta
       # Firebase App Check API
       #
-      # App Check works alongside other Firebase services to help protect your backend
-      #  resources from abuse, such as billing fraud or phishing. With App Check,
-      #  devices running your app will use an app or device attestation provider that
-      #  attests to one or both of the following: * Requests originate from your
-      #  authentic app * Requests originate from an authentic, untampered device This
-      #  attestation is attached to every request your app makes to your Firebase
-      #  backend resources. The Firebase App Check REST API allows you to manage your
-      #  App Check configurations programmatically. It also allows you to exchange
-      #  attestation material for App Check tokens directly without using a Firebase
-      #  SDK. Finally, it allows you to obtain the public key set necessary to validate
-      #  an App Check token yourself. [Learn more about App Check](https://firebase.
-      #  google.com/docs/app-check).
+      # Firebase App Check works alongside other Firebase services to help protect
+      #  your backend resources from abuse, such as billing fraud or phishing.
       #
       # @example
       #    require 'google/apis/firebaseappcheck_v1beta'
@@ -94,13 +84,15 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Accepts a AppAttest Artifact and Assertion, and uses the developer's
-        # preconfigured auth token to verify the token with Apple. Returns an
-        # AttestationToken with the App ID as specified by the `app` field included as
-        # attested claims.
+        # Accepts an App Attest assertion and an artifact previously obtained from
+        # ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns
+        # an App Check token encapsulated in an AttestationTokenResponse.
         # @param [String] app
-        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
-        #   /apps/`app_id`"
+        #   Required. The relative resource name of the iOS app, in the format: ```
+        #   projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
+        #   element can be replaced with the project ID of the Firebase project. Learn
+        #   more about using project identifiers in Google's [AIP 2510](https://google.aip.
+        #   dev/cloud/2510) standard.
         # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest] google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -131,13 +123,19 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured
-        # team and bundle IDs to verify the token with Apple. Returns an Attestation
-        # Artifact that can later be exchanged for an AttestationToken in
-        # ExchangeAppAttestAssertion.
+        # Accepts an App Attest CBOR attestation and verifies it with Apple using the
+        # developer's preconfigured team and bundle IDs. If valid, returns an
+        # attestation artifact that can later be exchanged for an
+        # AttestationTokenResponse using ExchangeAppAttestAssertion. For convenience and
+        # performance, this method's response object will also contain an App Check
+        # token encapsulated in an AttestationTokenResponse (if the verification is
+        # successful).
         # @param [String] app
-        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
-        #   /apps/`app_id`"
+        #   Required. The relative resource name of the iOS app, in the format: ```
+        #   projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
+        #   element can be replaced with the project ID of the Firebase project. Learn
+        #   more about using project identifiers in Google's [AIP 2510](https://google.aip.
+        #   dev/cloud/2510) standard.
         # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest] google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -365,11 +363,15 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Initiates the App Attest flow by generating a challenge which will be used as
-        # a type of nonce for this attestation.
+        # Generates a challenge that protects the integrity of an immediately following
+        # call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A
+        # challenge should not be reused for multiple calls.
         # @param [String] app
-        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
-        #   /apps/`app_id`"
+        #   Required. The relative resource name of the iOS app, in the format: ```
+        #   projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
+        #   element can be replaced with the project ID of the Firebase project. Learn
+        #   more about using project identifiers in Google's [AIP 2510](https://google.aip.
+        #   dev/cloud/2510) standard.
         # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest] google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -663,8 +665,8 @@ module Google
         # cannot be updated, nor will it be populated in the response, but you can
         # revoke the debug token using DeleteDebugToken.
         # @param [String] name
-        #   The relative resource name of the debug token, in the format: ``` projects/`
-        #   project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
+        #   Required. The relative resource name of the debug token, in the format: ```
+        #   projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
         # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaDebugToken] google_firebase_appcheck_v1beta_debug_token_object
         # @param [String] update_mask
         #   Required. A comma-separated list of names of fields in the DebugToken to

data/lib/google/apis/firebaseappcheck_v1beta.rb

@@ -21,18 +21,8 @@ module Google
   module Apis
     # Firebase App Check API
     #
-    # App Check works alongside other Firebase services to help protect your backend
-    # resources from abuse, such as billing fraud or phishing. With App Check,
-    # devices running your app will use an app or device attestation provider that
-    # attests to one or both of the following: * Requests originate from your
-    # authentic app * Requests originate from an authentic, untampered device This
-    # attestation is attached to every request your app makes to your Firebase
-    # backend resources. The Firebase App Check REST API allows you to manage your
-    # App Check configurations programmatically. It also allows you to exchange
-    # attestation material for App Check tokens directly without using a Firebase
-    # SDK. Finally, it allows you to obtain the public key set necessary to validate
-    # an App Check token yourself. [Learn more about App Check](https://firebase.
-    # google.com/docs/app-check).
+    # Firebase App Check works alongside other Firebase services to help protect
+    # your backend resources from abuse, such as billing fraud or phishing.
     #
     # @see https://firebase.google.com/docs/app-check
     module FirebaseappcheckV1beta

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firebaseappcheck_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
-  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.7.0
-  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.8.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta
 post_install_message: 
 rdoc_options: []
 require_paths: