1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Firebaseappcheck\Resource;
19
20use Google\Service\Firebaseappcheck\GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse;
21use Google\Service\Firebaseappcheck\GoogleFirebaseAppcheckV1betaRecaptchaV3Config;
22
23/**
24 * The "recaptchaV3Config" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $firebaseappcheckService = new Google\Service\Firebaseappcheck(...);
28 *   $recaptchaV3Config = $firebaseappcheckService->recaptchaV3Config;
29 *  </code>
30 */
31class ProjectsAppsRecaptchaV3Config extends \Google\Service\Resource
32{
33  /**
34   * Atomically gets the RecaptchaV3Configs for the specified list of apps. For
35   * security reasons, the `site_secret` field is never populated in the response.
36   * (recaptchaV3Config.batchGet)
37   *
38   * @param string $parent Required. The parent project name shared by all
39   * RecaptchaV3Configs being retrieved, in the format ```
40   * projects/{project_number} ``` The parent collection in the `name` field of
41   * any resource being retrieved must match this field, or the entire batch
42   * fails.
43   * @param array $optParams Optional parameters.
44   *
45   * @opt_param string names Required. The relative resource names of the
46   * RecaptchaV3Configs to retrieve, in the format: ```
47   * projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` A maximum of
48   * 100 objects can be retrieved in a batch.
49   * @return GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse
50   */
51  public function batchGet($parent, $optParams = [])
52  {
53    $params = ['parent' => $parent];
54    $params = array_merge($params, $optParams);
55    return $this->call('batchGet', [$params], GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse::class);
56  }
57  /**
58   * Gets the RecaptchaV3Config for the specified app. For security reasons, the
59   * `site_secret` field is never populated in the response.
60   * (recaptchaV3Config.get)
61   *
62   * @param string $name Required. The relative resource name of the
63   * RecaptchaV3Config, in the format: ```
64   * projects/{project_number}/apps/{app_id}/recaptchaV3Config ```
65   * @param array $optParams Optional parameters.
66   * @return GoogleFirebaseAppcheckV1betaRecaptchaV3Config
67   */
68  public function get($name, $optParams = [])
69  {
70    $params = ['name' => $name];
71    $params = array_merge($params, $optParams);
72    return $this->call('get', [$params], GoogleFirebaseAppcheckV1betaRecaptchaV3Config::class);
73  }
74  /**
75   * Updates the RecaptchaV3Config for the specified app. While this configuration
76   * is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3
77   * tokens for App Check tokens. For security reasons, the `site_secret` field is
78   * never populated in the response. (recaptchaV3Config.patch)
79   *
80   * @param string $name Required. The relative resource name of the reCAPTCHA v3
81   * configuration object, in the format: ```
82   * projects/{project_number}/apps/{app_id}/recaptchaV3Config ```
83   * @param GoogleFirebaseAppcheckV1betaRecaptchaV3Config $postBody
84   * @param array $optParams Optional parameters.
85   *
86   * @opt_param string updateMask Required. A comma-separated list of names of
87   * fields in the RecaptchaV3Config to update. Example: `site_secret`.
88   * @return GoogleFirebaseAppcheckV1betaRecaptchaV3Config
89   */
90  public function patch($name, GoogleFirebaseAppcheckV1betaRecaptchaV3Config $postBody, $optParams = [])
91  {
92    $params = ['name' => $name, 'postBody' => $postBody];
93    $params = array_merge($params, $optParams);
94    return $this->call('patch', [$params], GoogleFirebaseAppcheckV1betaRecaptchaV3Config::class);
95  }
96}
97
98// Adding a class alias for backwards compatibility with the previous class name.
99class_alias(ProjectsAppsRecaptchaV3Config::class, 'Google_Service_Firebaseappcheck_Resource_ProjectsAppsRecaptchaV3Config');
100