google-apis-firebaseappcheck_v1beta 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d08101c78c4d515bec5a78f17b4ef39a1251a1278c9ab9fd26b5ecbadbfad0f9
-  data.tar.gz: ae576a3e50337c28d93182a34785cc1ae7b247f9a046a9742d06483aa11221d5
+  metadata.gz: e64fc6286e5717dbd6787bfc9200f9ada8f408cd3486866399cde4ede0e89b47
+  data.tar.gz: 6d33ba05daf706aaa8b652a9cbceeee7b53852716e8d2db08f9346b8ec16e8f4
 SHA512:
-  metadata.gz: a9fc8d26c6cc1e8eb4da203a3d4816bba3280a9a401380bb7b23940391c1dab3960a0ddb243947d3180d8ac7153d9e968a38145a1de50d0dafbf51c1d3879eb4
-  data.tar.gz: 61a8c6fa5ccd2f609118b7c24aad7650e93342957486a6fde86c2965a87ce509879c073988e32235d074f9827aad4ec104aa97a129a7cac730ece4131e45d35a
+  metadata.gz: 23f7d060761dcb02b1879edcdeeea4d93836f1b4bef1beb45f250c35bb735dfa766f0832deb053cc88cc7ec64eef764cdba562ae58fa2fa0284e5d5230d181cc
+  data.tar.gz: 03173b0b0f42599efa4e69e58119e382271dd9f3a766bb56e32cb6c648b57b56ccbbdfae392949a01748d22a0105a643df390ee37d54f173c859bd798cd760af

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-firebaseappcheck_v1beta
 
+### v0.28.0 (2023-06-04)
+
+* Regenerated from discovery document revision 20230529
+
 ### v0.27.0 (2023-05-21)
 
 * Regenerated from discovery document revision 20230515

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

@@ -429,6 +429,13 @@ module Google
         # @return [String]
         attr_accessor :challenge
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         def initialize(**args)
            update!(**args)
         end
@@ -438,6 +445,7 @@ module Google
           @artifact = args[:artifact] if args.key?(:artifact)
           @assertion = args[:assertion] if args.key?(:assertion)
           @challenge = args[:challenge] if args.key?(:challenge)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
         end
       end
       
@@ -465,6 +473,13 @@ module Google
         # @return [String]
         attr_accessor :key_id
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         def initialize(**args)
            update!(**args)
         end
@@ -474,6 +489,7 @@ module Google
           @attestation_statement = args[:attestation_statement] if args.key?(:attestation_statement)
           @challenge = args[:challenge] if args.key?(:challenge)
           @key_id = args[:key_id] if args.key?(:key_id)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
         end
       end
       
@@ -521,6 +537,13 @@ module Google
         # @return [String]
         attr_accessor :custom_token
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         def initialize(**args)
            update!(**args)
         end
@@ -528,6 +551,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @custom_token = args[:custom_token] if args.key?(:custom_token)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
         end
       end
       
@@ -541,6 +565,13 @@ module Google
         # @return [String]
         attr_accessor :debug_token
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         def initialize(**args)
            update!(**args)
         end
@@ -548,6 +579,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @debug_token = args[:debug_token] if args.key?(:debug_token)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
         end
       end
       
@@ -562,6 +594,13 @@ module Google
         # @return [String]
         attr_accessor :device_token
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         def initialize(**args)
            update!(**args)
         end
@@ -569,6 +608,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @device_token = args[:device_token] if args.key?(:device_token)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
         end
       end
       
@@ -576,6 +616,13 @@ module Google
       class GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest
         include Google::Apis::Core::Hashable
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         # Required. The [integrity verdict response token from Play Integrity](https://
         # developer.android.com/google/play/integrity/verdict#decrypt-verify) issued to
         # your app.
@@ -589,6 +636,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
           @play_integrity_token = args[:play_integrity_token] if args.key?(:play_integrity_token)
         end
       end
@@ -597,6 +645,13 @@ module Google
       class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
         include Google::Apis::Core::Hashable
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         # Required. The reCAPTCHA token as returned by the [reCAPTCHA Enterprise
         # JavaScript API](https://cloud.google.com/recaptcha-enterprise/docs/instrument-
         # web-pages).
@@ -610,6 +665,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
           @recaptcha_enterprise_token = args[:recaptcha_enterprise_token] if args.key?(:recaptcha_enterprise_token)
         end
       end
@@ -638,6 +694,13 @@ module Google
       class GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest
         include Google::Apis::Core::Hashable
       
+        # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes
+        # to impose stricter TTL requirements for this exchange. Default: false.
+        # Corresponds to the JSON property `limitedUse`
+        # @return [Boolean]
+        attr_accessor :limited_use
+        alias_method :limited_use?, :limited_use
+      
         # Required. The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](
         # https://developers.google.com/recaptcha/docs/v3).
         # Corresponds to the JSON property `recaptchaV3Token`
@@ -650,6 +713,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @limited_use = args[:limited_use] if args.key?(:limited_use)
           @recaptcha_v3_token = args[:recaptcha_v3_token] if args.key?(:recaptcha_v3_token)
         end
       end

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.27.0"
+      GEM_VERSION = "0.28.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230515"
+      REVISION = "20230529"
     end
   end
 end

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

@@ -404,6 +404,7 @@ module Google
           property :artifact, :base64 => true, as: 'artifact'
           property :assertion, :base64 => true, as: 'assertion'
           property :challenge, :base64 => true, as: 'challenge'
+          property :limited_use, as: 'limitedUse'
         end
       end
       
@@ -413,6 +414,7 @@ module Google
           property :attestation_statement, :base64 => true, as: 'attestationStatement'
           property :challenge, :base64 => true, as: 'challenge'
           property :key_id, :base64 => true, as: 'keyId'
+          property :limited_use, as: 'limitedUse'
         end
       end
       
@@ -431,6 +433,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :custom_token, as: 'customToken'
+          property :limited_use, as: 'limitedUse'
         end
       end
       
@@ -438,6 +441,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :debug_token, as: 'debugToken'
+          property :limited_use, as: 'limitedUse'
         end
       end
       
@@ -445,12 +449,14 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :device_token, as: 'deviceToken'
+          property :limited_use, as: 'limitedUse'
         end
       end
       
       class GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :limited_use, as: 'limitedUse'
           property :play_integrity_token, as: 'playIntegrityToken'
         end
       end
@@ -458,6 +464,7 @@ module Google
       class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :limited_use, as: 'limitedUse'
           property :recaptcha_enterprise_token, as: 'recaptchaEnterpriseToken'
         end
       end
@@ -472,6 +479,7 @@ module Google
       class GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :limited_use, as: 'limitedUse'
           property :recaptcha_v3_token, as: 'recaptchaV3Token'
         end
       end

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

@@ -84,6 +84,126 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Accepts an App Attest assertion and an artifact previously obtained from
+        # ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns
+        # an AppCheckToken.
+        # @param [String] app
+        #   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.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def exchange_oauth_client_app_attest_assertion(app, google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:exchangeAppAttestAssertion', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Accepts an App Attest CBOR attestation and verifies it with Apple using your
+        # preconfigured team and bundle IDs. If valid, returns an attestation artifact
+        # that can later be exchanged for an AppCheckToken using
+        # ExchangeAppAttestAssertion. For convenience and performance, this method's
+        # response object will also contain an AppCheckToken (if the verification is
+        # successful).
+        # @param [String] app
+        #   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.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def exchange_oauth_client_app_attest_attestation(app, google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:exchangeAppAttestAttestation', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # 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 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.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def generate_oauth_client_app_attest_challenge(app, google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:generateAppAttestChallenge', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Verifies the given App Check token and returns token usage signals that
         # callers may act upon. This method currently only supports App Check tokens
         # exchanged from the following attestation providers: * Play Integrity API * App

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firebaseappcheck_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   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.27.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.28.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta
 post_install_message: 
 rdoc_options: []