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\GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse;
21use Google\Service\Firebaseappcheck\GoogleFirebaseAppcheckV1betaRecaptchaConfig;
22
23/**
24 * The "recaptchaConfig" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $firebaseappcheckService = new Google\Service\Firebaseappcheck(...);
28 *   $recaptchaConfig = $firebaseappcheckService->recaptchaConfig;
29 *  </code>
30 */
31class ProjectsAppsRecaptchaConfig extends \Google\Service\Resource
32{
33  /**
34   * Atomically gets the RecaptchaConfigs for the specified list of apps. For
35   * security reasons, the `site_secret` field is never populated in the response.
36   * (recaptchaConfig.batchGet)
37   *
38   * @param string $parent Required. The parent project name shared by all
39   * RecaptchaConfigs being retrieved, in the format ``` projects/{project_number}
40   * ``` The parent collection in the `name` field of any resource being retrieved
41   * must match this field, or the entire batch fails.
42   * @param array $optParams Optional parameters.
43   *
44   * @opt_param string names Required. The relative resource names of the
45   * RecaptchaConfigs to retrieve, in the format: ```
46   * projects/{project_number}/apps/{app_id}/recaptchaConfig ``` A maximum of 100
47   * objects can be retrieved in a batch.
48   * @return GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse
49   */
50  public function batchGet($parent, $optParams = [])
51  {
52    $params = ['parent' => $parent];
53    $params = array_merge($params, $optParams);
54    return $this->call('batchGet', [$params], GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse::class);
55  }
56  /**
57   * Gets the RecaptchaConfig for the specified app. For security reasons, the
58   * `site_secret` field is never populated in the response. (recaptchaConfig.get)
59   *
60   * @param string $name Required. The relative resource name of the
61   * RecaptchaConfig, in the format: ```
62   * projects/{project_number}/apps/{app_id}/recaptchaConfig ```
63   * @param array $optParams Optional parameters.
64   * @return GoogleFirebaseAppcheckV1betaRecaptchaConfig
65   */
66  public function get($name, $optParams = [])
67  {
68    $params = ['name' => $name];
69    $params = array_merge($params, $optParams);
70    return $this->call('get', [$params], GoogleFirebaseAppcheckV1betaRecaptchaConfig::class);
71  }
72  /**
73   * Updates the RecaptchaConfig for the specified app. While this configuration
74   * is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens
75   * for App Check tokens. For security reasons, the `site_secret` field is never
76   * populated in the response. (recaptchaConfig.patch)
77   *
78   * @param string $name Required. The relative resource name of the reCAPTCHA v3
79   * configuration object, in the format: ```
80   * projects/{project_number}/apps/{app_id}/recaptchaConfig ```
81   * @param GoogleFirebaseAppcheckV1betaRecaptchaConfig $postBody
82   * @param array $optParams Optional parameters.
83   *
84   * @opt_param string updateMask Required. A comma-separated list of names of
85   * fields in the RecaptchaConfig to update. Example: `site_secret`.
86   * @return GoogleFirebaseAppcheckV1betaRecaptchaConfig
87   */
88  public function patch($name, GoogleFirebaseAppcheckV1betaRecaptchaConfig $postBody, $optParams = [])
89  {
90    $params = ['name' => $name, 'postBody' => $postBody];
91    $params = array_merge($params, $optParams);
92    return $this->call('patch', [$params], GoogleFirebaseAppcheckV1betaRecaptchaConfig::class);
93  }
94}
95
96// Adding a class alias for backwards compatibility with the previous class name.
97class_alias(ProjectsAppsRecaptchaConfig::class, 'Google_Service_Firebaseappcheck_Resource_ProjectsAppsRecaptchaConfig');
98