google-apis-firebaseappcheck_v1beta 0.12.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0d2e62548eb22f40454ee9acba58efc083faf52d9533c94bc527c2db465835f4
4
- data.tar.gz: 07f29c46f49debfa98eba4322d6f76f6786d374aa4f3f94f6240f1bba0e3239e
3
+ metadata.gz: 0bc5a36b6165c91e9668b9b0fd6d0a900c4e44cb75aecb5bf2986001ad06af2a
4
+ data.tar.gz: 0355765af1133c7dce876b2a08cd12bcaf0f22e5f32565c7dc77183ee9938066
5
5
  SHA512:
6
- metadata.gz: 8b1642dd07e96fdf0d20a692fea07ebe3ea2b00713a360c0f88a25554dc658e0861270c5149736468f235a991ecb083d26df8c631d8be5bd10e3ddea38b7cc43
7
- data.tar.gz: e035e214978f01fca0fd1928596b403860b705d775651091a1521854df286cc111506318a679263998ac1432271054a85efd41870c5962fb80f5131121b4d42b
6
+ metadata.gz: 263a1781bbac5d34a268ed639a5f48e82ac2d65bfaa8ee44e602df7c0dbb359ceb171e2f8ba8a8505419b739fe8b7a8d57c1d0b9ebab26a7452319d31a74671d
7
+ data.tar.gz: f5584ae6578eeb648ba6e5c75973743bb756d88501e67eefbe2d7d14de62dfdf77302002c969f58dff3fe52a1e7724933d9a9d040e8334a92a50d075d5d579e6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-firebaseappcheck_v1beta
2
2
 
3
+ ### v0.15.0 (2022-04-05)
4
+
5
+ * Regenerated from discovery document revision 20220404
6
+
7
+ ### v0.14.0 (2022-03-29)
8
+
9
+ * Regenerated from discovery document revision 20220325
10
+
11
+ ### v0.13.0 (2022-03-22)
12
+
13
+ * Regenerated from discovery document revision 20220318
14
+
3
15
  ### v0.12.0 (2022-03-15)
4
16
 
5
17
  * Regenerated from discovery document revision 20220311
@@ -162,6 +162,25 @@ module Google
162
162
  end
163
163
  end
164
164
 
165
+ # Response message for the BatchGetPlayIntegrityConfigs method.
166
+ class GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse
167
+ include Google::Apis::Core::Hashable
168
+
169
+ # PlayIntegrityConfigs retrieved.
170
+ # Corresponds to the JSON property `configs`
171
+ # @return [Array<Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig>]
172
+ attr_accessor :configs
173
+
174
+ def initialize(**args)
175
+ update!(**args)
176
+ end
177
+
178
+ # Update properties of this object
179
+ def update!(**args)
180
+ @configs = args[:configs] if args.key?(:configs)
181
+ end
182
+ end
183
+
165
184
  # Response message for the BatchGetRecaptchaConfigs method.
166
185
  class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse
167
186
  include Google::Apis::Core::Hashable
@@ -200,6 +219,25 @@ module Google
200
219
  end
201
220
  end
202
221
 
222
+ # Response message for the BatchGetRecaptchaV3Configs method.
223
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse
224
+ include Google::Apis::Core::Hashable
225
+
226
+ # RecaptchaV3Configs retrieved.
227
+ # Corresponds to the JSON property `configs`
228
+ # @return [Array<Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config>]
229
+ attr_accessor :configs
230
+
231
+ def initialize(**args)
232
+ update!(**args)
233
+ end
234
+
235
+ # Update properties of this object
236
+ def update!(**args)
237
+ @configs = args[:configs] if args.key?(:configs)
238
+ end
239
+ end
240
+
203
241
  # Response message for the BatchGetSafetyNetConfigs method.
204
242
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
205
243
  include Google::Apis::Core::Hashable
@@ -533,6 +571,27 @@ module Google
533
571
  end
534
572
  end
535
573
 
574
+ # Request message for the ExchangePlayIntegrityToken method.
575
+ class GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest
576
+ include Google::Apis::Core::Hashable
577
+
578
+ # Required. The [integrity verdict response token from Play Integrity](https://
579
+ # developer.android.com/google/play/integrity/verdict#decrypt-verify) issued to
580
+ # your app.
581
+ # Corresponds to the JSON property `playIntegrityToken`
582
+ # @return [String]
583
+ attr_accessor :play_integrity_token
584
+
585
+ def initialize(**args)
586
+ update!(**args)
587
+ end
588
+
589
+ # Update properties of this object
590
+ def update!(**args)
591
+ @play_integrity_token = args[:play_integrity_token] if args.key?(:play_integrity_token)
592
+ end
593
+ end
594
+
536
595
  # Request message for the ExchangeRecaptchaEnterpriseToken method.
537
596
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
538
597
  include Google::Apis::Core::Hashable
@@ -655,6 +714,48 @@ module Google
655
714
  end
656
715
  end
657
716
 
717
+ # Request message for the GeneratePlayIntegrityChallenge method.
718
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest
719
+ include Google::Apis::Core::Hashable
720
+
721
+ def initialize(**args)
722
+ update!(**args)
723
+ end
724
+
725
+ # Update properties of this object
726
+ def update!(**args)
727
+ end
728
+ end
729
+
730
+ # Response message for the GeneratePlayIntegrityChallenge method.
731
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse
732
+ include Google::Apis::Core::Hashable
733
+
734
+ # A one-time use [challenge](https://developer.android.com/google/play/integrity/
735
+ # verdict#protect-against-replay-attacks) for the client to pass to the Play
736
+ # Integrity API.
737
+ # Corresponds to the JSON property `challenge`
738
+ # @return [String]
739
+ attr_accessor :challenge
740
+
741
+ # The duration from the time this challenge is minted until its expiration. This
742
+ # field is intended to ease client-side token management, since the client may
743
+ # have clock skew, but is still able to accurately measure a duration.
744
+ # Corresponds to the JSON property `ttl`
745
+ # @return [String]
746
+ attr_accessor :ttl
747
+
748
+ def initialize(**args)
749
+ update!(**args)
750
+ end
751
+
752
+ # Update properties of this object
753
+ def update!(**args)
754
+ @challenge = args[:challenge] if args.key?(:challenge)
755
+ @ttl = args[:ttl] if args.key?(:ttl)
756
+ end
757
+ end
758
+
658
759
  # Response message for the ListDebugTokens method.
659
760
  class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
660
761
  include Google::Apis::Core::Hashable
@@ -713,6 +814,41 @@ module Google
713
814
  end
714
815
  end
715
816
 
817
+ # An app's Play Integrity configuration object. This configuration controls
818
+ # certain properties of the App Check token returned by
819
+ # ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256
820
+ # certificate fingerprints are used to validate tokens issued by the Play
821
+ # Integrity API; please register them via the Firebase Console or
822
+ # programmatically via the [Firebase Management Service](https://firebase.google.
823
+ # com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).
824
+ class GoogleFirebaseAppcheckV1betaPlayIntegrityConfig
825
+ include Google::Apis::Core::Hashable
826
+
827
+ # Required. The relative resource name of the Play Integrity configuration
828
+ # object, in the format: ``` projects/`project_number`/apps/`app_id`/
829
+ # playIntegrityConfig ```
830
+ # Corresponds to the JSON property `name`
831
+ # @return [String]
832
+ attr_accessor :name
833
+
834
+ # Specifies the duration for which App Check tokens exchanged from Play
835
+ # Integrity tokens will be valid. If unset, a default value of 1 hour is assumed.
836
+ # Must be between 30 minutes and 7 days, inclusive.
837
+ # Corresponds to the JSON property `tokenTtl`
838
+ # @return [String]
839
+ attr_accessor :token_ttl
840
+
841
+ def initialize(**args)
842
+ update!(**args)
843
+ end
844
+
845
+ # Update properties of this object
846
+ def update!(**args)
847
+ @name = args[:name] if args.key?(:name)
848
+ @token_ttl = args[:token_ttl] if args.key?(:token_ttl)
849
+ end
850
+ end
851
+
716
852
  # A JWK as specified by [section 4 of RFC 7517](https://tools.ietf.org/html/
717
853
  # rfc7517#section-4) and [section 6.3.1 of RFC 7518](https://tools.ietf.org/html/
718
854
  # rfc7518#section-6.3.1).
@@ -880,6 +1016,55 @@ module Google
880
1016
  end
881
1017
  end
882
1018
 
1019
+ # An app's reCAPTCHA v3 configuration object. This configuration is used by
1020
+ # ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by
1021
+ # reCAPTCHA v3. It also controls certain properties of the returned App Check
1022
+ # token, such as its ttl.
1023
+ class GoogleFirebaseAppcheckV1betaRecaptchaV3Config
1024
+ include Google::Apis::Core::Hashable
1025
+
1026
+ # Required. The relative resource name of the reCAPTCHA v3 configuration object,
1027
+ # in the format: ``` projects/`project_number`/apps/`app_id`/recaptchaV3Config ``
1028
+ # `
1029
+ # Corresponds to the JSON property `name`
1030
+ # @return [String]
1031
+ attr_accessor :name
1032
+
1033
+ # Required. Input only. The site secret used to identify your service for
1034
+ # reCAPTCHA v3 verification. For security reasons, this field will never be
1035
+ # populated in any response.
1036
+ # Corresponds to the JSON property `siteSecret`
1037
+ # @return [String]
1038
+ attr_accessor :site_secret
1039
+
1040
+ # Output only. Whether the `site_secret` field was previously set. Since we will
1041
+ # never return the `site_secret` field, this field is the only way to find out
1042
+ # whether it was previously set.
1043
+ # Corresponds to the JSON property `siteSecretSet`
1044
+ # @return [Boolean]
1045
+ attr_accessor :site_secret_set
1046
+ alias_method :site_secret_set?, :site_secret_set
1047
+
1048
+ # Specifies the duration for which App Check tokens exchanged from reCAPTCHA
1049
+ # tokens will be valid. If unset, a default value of 1 day is assumed. Must be
1050
+ # between 30 minutes and 7 days, inclusive.
1051
+ # Corresponds to the JSON property `tokenTtl`
1052
+ # @return [String]
1053
+ attr_accessor :token_ttl
1054
+
1055
+ def initialize(**args)
1056
+ update!(**args)
1057
+ end
1058
+
1059
+ # Update properties of this object
1060
+ def update!(**args)
1061
+ @name = args[:name] if args.key?(:name)
1062
+ @site_secret = args[:site_secret] if args.key?(:site_secret)
1063
+ @site_secret_set = args[:site_secret_set] if args.key?(:site_secret_set)
1064
+ @token_ttl = args[:token_ttl] if args.key?(:token_ttl)
1065
+ end
1066
+ end
1067
+
883
1068
  # An app's SafetyNet configuration object. This configuration controls certain
884
1069
  # properties of the App Check token returned by ExchangeSafetyNetToken, such as
885
1070
  # its ttl. Note that your registered SHA-256 certificate fingerprints are used
@@ -974,8 +1159,7 @@ module Google
974
1159
  # A generic empty message that you can re-use to avoid defining duplicated empty
975
1160
  # messages in your APIs. A typical example is to use it as the request or the
976
1161
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
977
- # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
978
- # `Empty` is empty JSON object ````.
1162
+ # protobuf.Empty) returns (google.protobuf.Empty); `
979
1163
  class GoogleProtobufEmpty
980
1164
  include Google::Apis::Core::Hashable
981
1165
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirebaseappcheckV1beta
18
18
  # Version of the google-apis-firebaseappcheck_v1beta gem
19
- GEM_VERSION = "0.12.0"
19
+ GEM_VERSION = "0.15.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220311"
25
+ REVISION = "20220404"
26
26
  end
27
27
  end
28
28
  end
@@ -52,6 +52,12 @@ module Google
52
52
  include Google::Apis::Core::JsonObjectSupport
53
53
  end
54
54
 
55
+ class GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
55
61
  class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse
56
62
  class Representation < Google::Apis::Core::JsonRepresentation; end
57
63
 
@@ -64,6 +70,12 @@ module Google
64
70
  include Google::Apis::Core::JsonObjectSupport
65
71
  end
66
72
 
73
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
67
79
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
68
80
  class Representation < Google::Apis::Core::JsonRepresentation; end
69
81
 
@@ -130,6 +142,12 @@ module Google
130
142
  include Google::Apis::Core::JsonObjectSupport
131
143
  end
132
144
 
145
+ class GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
133
151
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
134
152
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
153
 
@@ -166,6 +184,18 @@ module Google
166
184
  include Google::Apis::Core::JsonObjectSupport
167
185
  end
168
186
 
187
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
193
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
169
199
  class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
170
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
171
201
 
@@ -178,6 +208,12 @@ module Google
178
208
  include Google::Apis::Core::JsonObjectSupport
179
209
  end
180
210
 
211
+ class GoogleFirebaseAppcheckV1betaPlayIntegrityConfig
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
181
217
  class GoogleFirebaseAppcheckV1betaPublicJwk
182
218
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
219
 
@@ -202,6 +238,12 @@ module Google
202
238
  include Google::Apis::Core::JsonObjectSupport
203
239
  end
204
240
 
241
+ class GoogleFirebaseAppcheckV1betaRecaptchaV3Config
242
+ class Representation < Google::Apis::Core::JsonRepresentation; end
243
+
244
+ include Google::Apis::Core::JsonObjectSupport
245
+ end
246
+
205
247
  class GoogleFirebaseAppcheckV1betaSafetyNetConfig
206
248
  class Representation < Google::Apis::Core::JsonRepresentation; end
207
249
 
@@ -267,6 +309,14 @@ module Google
267
309
  end
268
310
  end
269
311
 
312
+ class GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse
313
+ # @private
314
+ class Representation < Google::Apis::Core::JsonRepresentation
315
+ collection :configs, as: 'configs', class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig, decorator: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig::Representation
316
+
317
+ end
318
+ end
319
+
270
320
  class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse
271
321
  # @private
272
322
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -283,6 +333,14 @@ module Google
283
333
  end
284
334
  end
285
335
 
336
+ class GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse
337
+ # @private
338
+ class Representation < Google::Apis::Core::JsonRepresentation
339
+ collection :configs, as: 'configs', class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config, decorator: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config::Representation
340
+
341
+ end
342
+ end
343
+
286
344
  class GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse
287
345
  # @private
288
346
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -378,6 +436,13 @@ module Google
378
436
  end
379
437
  end
380
438
 
439
+ class GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest
440
+ # @private
441
+ class Representation < Google::Apis::Core::JsonRepresentation
442
+ property :play_integrity_token, as: 'playIntegrityToken'
443
+ end
444
+ end
445
+
381
446
  class GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest
382
447
  # @private
383
448
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -420,6 +485,20 @@ module Google
420
485
  end
421
486
  end
422
487
 
488
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest
489
+ # @private
490
+ class Representation < Google::Apis::Core::JsonRepresentation
491
+ end
492
+ end
493
+
494
+ class GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse
495
+ # @private
496
+ class Representation < Google::Apis::Core::JsonRepresentation
497
+ property :challenge, as: 'challenge'
498
+ property :ttl, as: 'ttl'
499
+ end
500
+ end
501
+
423
502
  class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
424
503
  # @private
425
504
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -438,6 +517,14 @@ module Google
438
517
  end
439
518
  end
440
519
 
520
+ class GoogleFirebaseAppcheckV1betaPlayIntegrityConfig
521
+ # @private
522
+ class Representation < Google::Apis::Core::JsonRepresentation
523
+ property :name, as: 'name'
524
+ property :token_ttl, as: 'tokenTtl'
525
+ end
526
+ end
527
+
441
528
  class GoogleFirebaseAppcheckV1betaPublicJwk
442
529
  # @private
443
530
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -477,6 +564,16 @@ module Google
477
564
  end
478
565
  end
479
566
 
567
+ class GoogleFirebaseAppcheckV1betaRecaptchaV3Config
568
+ # @private
569
+ class Representation < Google::Apis::Core::JsonRepresentation
570
+ property :name, as: 'name'
571
+ property :site_secret, as: 'siteSecret'
572
+ property :site_secret_set, as: 'siteSecretSet'
573
+ property :token_ttl, as: 'tokenTtl'
574
+ end
575
+ end
576
+
480
577
  class GoogleFirebaseAppcheckV1betaSafetyNetConfig
481
578
  # @private
482
579
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -282,6 +282,45 @@ module Google
282
282
  execute_or_queue_command(command, &block)
283
283
  end
284
284
 
285
+ # Validates an [integrity verdict response token from Play Integrity](https://
286
+ # developer.android.com/google/play/integrity/verdict#decrypt-verify). If valid,
287
+ # returns an AppCheckToken.
288
+ # @param [String] app
289
+ # Required. The relative resource name of the Android app, in the format: ```
290
+ # projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
291
+ # element can be replaced with the project ID of the Firebase project. Learn
292
+ # more about using project identifiers in Google's [AIP 2510](https://google.aip.
293
+ # dev/cloud/2510) standard.
294
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest] google_firebase_appcheck_v1beta_exchange_play_integrity_token_request_object
295
+ # @param [String] fields
296
+ # Selector specifying which fields to include in a partial response.
297
+ # @param [String] quota_user
298
+ # Available to use for quota purposes for server-side applications. Can be any
299
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
300
+ # @param [Google::Apis::RequestOptions] options
301
+ # Request-specific options
302
+ #
303
+ # @yield [result, err] Result & error if block supplied
304
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken] parsed result object
305
+ # @yieldparam err [StandardError] error object if request failed
306
+ #
307
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken]
308
+ #
309
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
310
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
311
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
312
+ def exchange_project_app_play_integrity_token(app, google_firebase_appcheck_v1beta_exchange_play_integrity_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
313
+ command = make_simple_command(:post, 'v1beta/{+app}:exchangePlayIntegrityToken', options)
314
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest::Representation
315
+ command.request_object = google_firebase_appcheck_v1beta_exchange_play_integrity_token_request_object
316
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken::Representation
317
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppCheckToken
318
+ command.params['app'] = app unless app.nil?
319
+ command.query['fields'] = fields unless fields.nil?
320
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
321
+ execute_or_queue_command(command, &block)
322
+ end
323
+
285
324
  # Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/
286
325
  # recaptcha-enterprise/docs/create-assessment#retrieve_token). If valid, returns
287
326
  # an App Check token AppCheckToken.
@@ -474,6 +513,47 @@ module Google
474
513
  execute_or_queue_command(command, &block)
475
514
  end
476
515
 
516
+ # Generates a challenge that protects the integrity of an immediately following
517
+ # integrity verdict request to the Play Integrity API. The next call to
518
+ # ExchangePlayIntegrityToken using the resulting integrity token will verify the
519
+ # presence and validity of the challenge. A challenge should not be reused for
520
+ # multiple calls.
521
+ # @param [String] app
522
+ # Required. The relative resource name of the app, in the format: ``` projects/`
523
+ # project_number`/apps/`app_id` ``` If necessary, the `project_number` element
524
+ # can be replaced with the project ID of the Firebase project. Learn more about
525
+ # using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/
526
+ # 2510) standard.
527
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest] google_firebase_appcheck_v1beta_generate_play_integrity_challenge_request_object
528
+ # @param [String] fields
529
+ # Selector specifying which fields to include in a partial response.
530
+ # @param [String] quota_user
531
+ # Available to use for quota purposes for server-side applications. Can be any
532
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
533
+ # @param [Google::Apis::RequestOptions] options
534
+ # Request-specific options
535
+ #
536
+ # @yield [result, err] Result & error if block supplied
537
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse] parsed result object
538
+ # @yieldparam err [StandardError] error object if request failed
539
+ #
540
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse]
541
+ #
542
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
543
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
544
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
545
+ def generate_project_app_play_integrity_challenge(app, google_firebase_appcheck_v1beta_generate_play_integrity_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
546
+ command = make_simple_command(:post, 'v1beta/{+app}:generatePlayIntegrityChallenge', options)
547
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest::Representation
548
+ command.request_object = google_firebase_appcheck_v1beta_generate_play_integrity_challenge_request_object
549
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse::Representation
550
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse
551
+ command.params['app'] = app unless app.nil?
552
+ command.query['fields'] = fields unless fields.nil?
553
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
554
+ execute_or_queue_command(command, &block)
555
+ end
556
+
477
557
  # Atomically gets the AppAttestConfigs for the specified list of apps.
478
558
  # @param [String] parent
479
559
  # Required. The parent project name shared by all AppAttestConfigs being
@@ -886,6 +966,116 @@ module Google
886
966
  execute_or_queue_command(command, &block)
887
967
  end
888
968
 
969
+ # Atomically gets the PlayIntegrityConfigs for the specified list of apps.
970
+ # @param [String] parent
971
+ # Required. The parent project name shared by all PlayIntegrityConfigs being
972
+ # retrieved, in the format ``` projects/`project_number` ``` The parent
973
+ # collection in the `name` field of any resource being retrieved must match this
974
+ # field, or the entire batch fails.
975
+ # @param [Array<String>, String] names
976
+ # Required. The relative resource names of the PlayIntegrityConfigs to retrieve,
977
+ # in the format ``` projects/`project_number`/apps/`app_id`/playIntegrityConfig `
978
+ # `` A maximum of 100 objects can be retrieved in a batch.
979
+ # @param [String] fields
980
+ # Selector specifying which fields to include in a partial response.
981
+ # @param [String] quota_user
982
+ # Available to use for quota purposes for server-side applications. Can be any
983
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
984
+ # @param [Google::Apis::RequestOptions] options
985
+ # Request-specific options
986
+ #
987
+ # @yield [result, err] Result & error if block supplied
988
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse] parsed result object
989
+ # @yieldparam err [StandardError] error object if request failed
990
+ #
991
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse]
992
+ #
993
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
994
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
995
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
996
+ def batch_project_app_play_integrity_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
997
+ command = make_simple_command(:get, 'v1beta/{+parent}/apps/-/playIntegrityConfig:batchGet', options)
998
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse::Representation
999
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse
1000
+ command.params['parent'] = parent unless parent.nil?
1001
+ command.query['names'] = names unless names.nil?
1002
+ command.query['fields'] = fields unless fields.nil?
1003
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1004
+ execute_or_queue_command(command, &block)
1005
+ end
1006
+
1007
+ # Gets the PlayIntegrityConfig for the specified app.
1008
+ # @param [String] name
1009
+ # Required. The relative resource name of the PlayIntegrityConfig, in the format:
1010
+ # ``` projects/`project_number`/apps/`app_id`/playIntegrityConfig ```
1011
+ # @param [String] fields
1012
+ # Selector specifying which fields to include in a partial response.
1013
+ # @param [String] quota_user
1014
+ # Available to use for quota purposes for server-side applications. Can be any
1015
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1016
+ # @param [Google::Apis::RequestOptions] options
1017
+ # Request-specific options
1018
+ #
1019
+ # @yield [result, err] Result & error if block supplied
1020
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig] parsed result object
1021
+ # @yieldparam err [StandardError] error object if request failed
1022
+ #
1023
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig]
1024
+ #
1025
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1026
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1027
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1028
+ def get_project_app_play_integrity_config(name, fields: nil, quota_user: nil, options: nil, &block)
1029
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1030
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig::Representation
1031
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig
1032
+ command.params['name'] = name unless name.nil?
1033
+ command.query['fields'] = fields unless fields.nil?
1034
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1035
+ execute_or_queue_command(command, &block)
1036
+ end
1037
+
1038
+ # Updates the PlayIntegrityConfig for the specified app. While this
1039
+ # configuration is incomplete or invalid, the app will be unable to exchange
1040
+ # Play Integrity tokens for App Check tokens.
1041
+ # @param [String] name
1042
+ # Required. The relative resource name of the Play Integrity configuration
1043
+ # object, in the format: ``` projects/`project_number`/apps/`app_id`/
1044
+ # playIntegrityConfig ```
1045
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig] google_firebase_appcheck_v1beta_play_integrity_config_object
1046
+ # @param [String] update_mask
1047
+ # Required. A comma-separated list of names of fields in the PlayIntegrityConfig
1048
+ # Gets to update. Example: `token_ttl`.
1049
+ # @param [String] fields
1050
+ # Selector specifying which fields to include in a partial response.
1051
+ # @param [String] quota_user
1052
+ # Available to use for quota purposes for server-side applications. Can be any
1053
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1054
+ # @param [Google::Apis::RequestOptions] options
1055
+ # Request-specific options
1056
+ #
1057
+ # @yield [result, err] Result & error if block supplied
1058
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig] parsed result object
1059
+ # @yieldparam err [StandardError] error object if request failed
1060
+ #
1061
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig]
1062
+ #
1063
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1064
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1065
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1066
+ def patch_project_app_play_integrity_config(name, google_firebase_appcheck_v1beta_play_integrity_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1067
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1068
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig::Representation
1069
+ command.request_object = google_firebase_appcheck_v1beta_play_integrity_config_object
1070
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig::Representation
1071
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaPlayIntegrityConfig
1072
+ command.params['name'] = name unless name.nil?
1073
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1074
+ command.query['fields'] = fields unless fields.nil?
1075
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1076
+ execute_or_queue_command(command, &block)
1077
+ end
1078
+
889
1079
  # Atomically gets the RecaptchaConfigs for the specified list of apps. For
890
1080
  # security reasons, the `site_secret` field is never populated in the response.
891
1081
  # @param [String] parent
@@ -1110,6 +1300,119 @@ module Google
1110
1300
  execute_or_queue_command(command, &block)
1111
1301
  end
1112
1302
 
1303
+ # Atomically gets the RecaptchaV3Configs for the specified list of apps. For
1304
+ # security reasons, the `site_secret` field is never populated in the response.
1305
+ # @param [String] parent
1306
+ # Required. The parent project name shared by all RecaptchaV3Configs being
1307
+ # retrieved, in the format ``` projects/`project_number` ``` The parent
1308
+ # collection in the `name` field of any resource being retrieved must match this
1309
+ # field, or the entire batch fails.
1310
+ # @param [Array<String>, String] names
1311
+ # Required. The relative resource names of the RecaptchaV3Configs to retrieve,
1312
+ # in the format: ``` projects/`project_number`/apps/`app_id`/recaptchaV3Config ``
1313
+ # ` A maximum of 100 objects can be retrieved in a batch.
1314
+ # @param [String] fields
1315
+ # Selector specifying which fields to include in a partial response.
1316
+ # @param [String] quota_user
1317
+ # Available to use for quota purposes for server-side applications. Can be any
1318
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1319
+ # @param [Google::Apis::RequestOptions] options
1320
+ # Request-specific options
1321
+ #
1322
+ # @yield [result, err] Result & error if block supplied
1323
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse] parsed result object
1324
+ # @yieldparam err [StandardError] error object if request failed
1325
+ #
1326
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse]
1327
+ #
1328
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1329
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1330
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1331
+ def batch_project_app_recaptcha_v3_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
1332
+ command = make_simple_command(:get, 'v1beta/{+parent}/apps/-/recaptchaV3Config:batchGet', options)
1333
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse::Representation
1334
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse
1335
+ command.params['parent'] = parent unless parent.nil?
1336
+ command.query['names'] = names unless names.nil?
1337
+ command.query['fields'] = fields unless fields.nil?
1338
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1339
+ execute_or_queue_command(command, &block)
1340
+ end
1341
+
1342
+ # Gets the RecaptchaV3Config for the specified app. For security reasons, the `
1343
+ # site_secret` field is never populated in the response.
1344
+ # @param [String] name
1345
+ # Required. The relative resource name of the RecaptchaV3Config, in the format: `
1346
+ # `` projects/`project_number`/apps/`app_id`/recaptchaV3Config ```
1347
+ # @param [String] fields
1348
+ # Selector specifying which fields to include in a partial response.
1349
+ # @param [String] quota_user
1350
+ # Available to use for quota purposes for server-side applications. Can be any
1351
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1352
+ # @param [Google::Apis::RequestOptions] options
1353
+ # Request-specific options
1354
+ #
1355
+ # @yield [result, err] Result & error if block supplied
1356
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config] parsed result object
1357
+ # @yieldparam err [StandardError] error object if request failed
1358
+ #
1359
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config]
1360
+ #
1361
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1362
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1363
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1364
+ def get_project_app_recaptcha_v3_config(name, fields: nil, quota_user: nil, options: nil, &block)
1365
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1366
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config::Representation
1367
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config
1368
+ command.params['name'] = name unless name.nil?
1369
+ command.query['fields'] = fields unless fields.nil?
1370
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1371
+ execute_or_queue_command(command, &block)
1372
+ end
1373
+
1374
+ # Updates the RecaptchaV3Config for the specified app. While this configuration
1375
+ # is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3
1376
+ # tokens for App Check tokens. For security reasons, the `site_secret` field is
1377
+ # never populated in the response.
1378
+ # @param [String] name
1379
+ # Required. The relative resource name of the reCAPTCHA v3 configuration object,
1380
+ # in the format: ``` projects/`project_number`/apps/`app_id`/recaptchaV3Config ``
1381
+ # `
1382
+ # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config] google_firebase_appcheck_v1beta_recaptcha_v3_config_object
1383
+ # @param [String] update_mask
1384
+ # Required. A comma-separated list of names of fields in the RecaptchaV3Config
1385
+ # to update. Example: `site_secret`.
1386
+ # @param [String] fields
1387
+ # Selector specifying which fields to include in a partial response.
1388
+ # @param [String] quota_user
1389
+ # Available to use for quota purposes for server-side applications. Can be any
1390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1391
+ # @param [Google::Apis::RequestOptions] options
1392
+ # Request-specific options
1393
+ #
1394
+ # @yield [result, err] Result & error if block supplied
1395
+ # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config] parsed result object
1396
+ # @yieldparam err [StandardError] error object if request failed
1397
+ #
1398
+ # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config]
1399
+ #
1400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1403
+ def patch_project_app_recaptcha_v3_config(name, google_firebase_appcheck_v1beta_recaptcha_v3_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1404
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1405
+ command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config::Representation
1406
+ command.request_object = google_firebase_appcheck_v1beta_recaptcha_v3_config_object
1407
+ command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config::Representation
1408
+ command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaRecaptchaV3Config
1409
+ command.params['name'] = name unless name.nil?
1410
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1411
+ command.query['fields'] = fields unless fields.nil?
1412
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1413
+ execute_or_queue_command(command, &block)
1414
+ end
1415
+
1113
1416
  # Atomically gets the SafetyNetConfigs for the specified list of apps.
1114
1417
  # @param [String] parent
1115
1418
  # Required. The parent project name shared by all SafetyNetConfigs being
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firebaseappcheck_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.0
4
+ version: 0.15.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-03-21 00:00:00.000000000 Z
11
+ date: 2022-04-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.12.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.15.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firebaseappcheck_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []