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\RealTimeBidding\Resource;
19
20use Google\Service\RealTimeBidding\Endpoint;
21use Google\Service\RealTimeBidding\ListEndpointsResponse;
22
23/**
24 * The "endpoints" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $realtimebiddingService = new Google\Service\RealTimeBidding(...);
28 *   $endpoints = $realtimebiddingService->endpoints;
29 *  </code>
30 */
31class BiddersEndpoints extends \Google\Service\Resource
32{
33  /**
34   * Gets a bidder endpoint by its name. (endpoints.get)
35   *
36   * @param string $name Required. Name of the bidder endpoint to get. Format:
37   * `bidders/{bidderAccountId}/endpoints/{endpointId}`
38   * @param array $optParams Optional parameters.
39   * @return Endpoint
40   */
41  public function get($name, $optParams = [])
42  {
43    $params = ['name' => $name];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], Endpoint::class);
46  }
47  /**
48   * Lists all the bidder's endpoints. (endpoints.listBiddersEndpoints)
49   *
50   * @param string $parent Required. Name of the bidder whose endpoints will be
51   * listed. Format: `bidders/{bidderAccountId}`
52   * @param array $optParams Optional parameters.
53   *
54   * @opt_param int pageSize The maximum number of endpoints to return. If
55   * unspecified, at most 100 endpoints will be returned. The maximum value is
56   * 500; values above 500 will be coerced to 500.
57   * @opt_param string pageToken A token identifying a page of results the server
58   * should return. This value is received from a previous `ListEndpoints` call in
59   * ListEndpointsResponse.nextPageToken.
60   * @return ListEndpointsResponse
61   */
62  public function listBiddersEndpoints($parent, $optParams = [])
63  {
64    $params = ['parent' => $parent];
65    $params = array_merge($params, $optParams);
66    return $this->call('list', [$params], ListEndpointsResponse::class);
67  }
68  /**
69   * Updates a bidder's endpoint. (endpoints.patch)
70   *
71   * @param string $name Output only. Name of the endpoint resource that must
72   * follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where
73   * {bidderAccountId} is the account ID of the bidder who operates this endpoint,
74   * and {endpointId} is a unique ID assigned by the server.
75   * @param Endpoint $postBody
76   * @param array $optParams Optional parameters.
77   *
78   * @opt_param string updateMask Field mask to use for partial in-place updates.
79   * @return Endpoint
80   */
81  public function patch($name, Endpoint $postBody, $optParams = [])
82  {
83    $params = ['name' => $name, 'postBody' => $postBody];
84    $params = array_merge($params, $optParams);
85    return $this->call('patch', [$params], Endpoint::class);
86  }
87}
88
89// Adding a class alias for backwards compatibility with the previous class name.
90class_alias(BiddersEndpoints::class, 'Google_Service_RealTimeBidding_Resource_BiddersEndpoints');
91