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 |
|
---|
18 | namespace Google\Service\CCAIPlatform\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\CCAIPlatform\ContactCenter;
|
---|
21 | use Google\Service\CCAIPlatform\ListContactCentersResponse;
|
---|
22 | use Google\Service\CCAIPlatform\Operation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "contactCenters" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $contactcenteraiplatformService = new Google\Service\CCAIPlatform(...);
|
---|
29 | * $contactCenters = $contactcenteraiplatformService->projects_locations_contactCenters;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsContactCenters extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a new ContactCenter in a given project and location.
|
---|
36 | * (contactCenters.create)
|
---|
37 | *
|
---|
38 | * @param string $parent Required. Value for parent.
|
---|
39 | * @param ContactCenter $postBody
|
---|
40 | * @param array $optParams Optional parameters.
|
---|
41 | *
|
---|
42 | * @opt_param string contactCenterId Required. Id of the requesting object If
|
---|
43 | * auto-generating Id server-side, remove this field and contact_center_id from
|
---|
44 | * the method_signature of Create RPC
|
---|
45 | * @opt_param string requestId Optional. An optional request ID to identify
|
---|
46 | * requests. Specify a unique request ID so that if you must retry your request,
|
---|
47 | * the server will know to ignore the request if it has already been completed.
|
---|
48 | * The server will guarantee that for at least 60 minutes since the first
|
---|
49 | * request. For example, consider a situation where you make an initial request
|
---|
50 | * and the request times out. If you make the request again with the same
|
---|
51 | * request ID, the server can check if original operation with the same request
|
---|
52 | * ID was received, and if so, will ignore the second request. This prevents
|
---|
53 | * clients from accidentally creating duplicate commitments. The request ID must
|
---|
54 | * be a valid UUID with the exception that zero UUID is not supported
|
---|
55 | * (00000000-0000-0000-0000-000000000000).
|
---|
56 | * @return Operation
|
---|
57 | * @throws \Google\Service\Exception
|
---|
58 | */
|
---|
59 | public function create($parent, ContactCenter $postBody, $optParams = [])
|
---|
60 | {
|
---|
61 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
62 | $params = array_merge($params, $optParams);
|
---|
63 | return $this->call('create', [$params], Operation::class);
|
---|
64 | }
|
---|
65 | /**
|
---|
66 | * Deletes a single ContactCenter. (contactCenters.delete)
|
---|
67 | *
|
---|
68 | * @param string $name Required. Name of the resource
|
---|
69 | * @param array $optParams Optional parameters.
|
---|
70 | *
|
---|
71 | * @opt_param string requestId Optional. An optional request ID to identify
|
---|
72 | * requests. Specify a unique request ID so that if you must retry your request,
|
---|
73 | * the server will know to ignore the request if it has already been completed.
|
---|
74 | * The server will guarantee that for at least 60 minutes after the first
|
---|
75 | * request. For example, consider a situation where you make an initial request
|
---|
76 | * and the request times out. If you make the request again with the same
|
---|
77 | * request ID, the server can check if original operation with the same request
|
---|
78 | * ID was received, and if so, will ignore the second request. This prevents
|
---|
79 | * clients from accidentally creating duplicate commitments. The request ID must
|
---|
80 | * be a valid UUID with the exception that zero UUID is not supported
|
---|
81 | * (00000000-0000-0000-0000-000000000000).
|
---|
82 | * @return Operation
|
---|
83 | * @throws \Google\Service\Exception
|
---|
84 | */
|
---|
85 | public function delete($name, $optParams = [])
|
---|
86 | {
|
---|
87 | $params = ['name' => $name];
|
---|
88 | $params = array_merge($params, $optParams);
|
---|
89 | return $this->call('delete', [$params], Operation::class);
|
---|
90 | }
|
---|
91 | /**
|
---|
92 | * Gets details of a single ContactCenter. (contactCenters.get)
|
---|
93 | *
|
---|
94 | * @param string $name Required. Name of the resource
|
---|
95 | * @param array $optParams Optional parameters.
|
---|
96 | * @return ContactCenter
|
---|
97 | * @throws \Google\Service\Exception
|
---|
98 | */
|
---|
99 | public function get($name, $optParams = [])
|
---|
100 | {
|
---|
101 | $params = ['name' => $name];
|
---|
102 | $params = array_merge($params, $optParams);
|
---|
103 | return $this->call('get', [$params], ContactCenter::class);
|
---|
104 | }
|
---|
105 | /**
|
---|
106 | * Lists ContactCenters in a given project and location.
|
---|
107 | * (contactCenters.listProjectsLocationsContactCenters)
|
---|
108 | *
|
---|
109 | * @param string $parent Required. Parent value for ListContactCentersRequest
|
---|
110 | * @param array $optParams Optional parameters.
|
---|
111 | *
|
---|
112 | * @opt_param string filter Filtering results
|
---|
113 | * @opt_param string orderBy Hint for how to order the results
|
---|
114 | * @opt_param int pageSize Requested page size. Server may return fewer items
|
---|
115 | * than requested. If unspecified, server will pick an appropriate default.
|
---|
116 | * @opt_param string pageToken A token identifying a page of results the server
|
---|
117 | * should return.
|
---|
118 | * @return ListContactCentersResponse
|
---|
119 | * @throws \Google\Service\Exception
|
---|
120 | */
|
---|
121 | public function listProjectsLocationsContactCenters($parent, $optParams = [])
|
---|
122 | {
|
---|
123 | $params = ['parent' => $parent];
|
---|
124 | $params = array_merge($params, $optParams);
|
---|
125 | return $this->call('list', [$params], ListContactCentersResponse::class);
|
---|
126 | }
|
---|
127 | /**
|
---|
128 | * Updates the parameters of a single ContactCenter. (contactCenters.patch)
|
---|
129 | *
|
---|
130 | * @param string $name name of resource
|
---|
131 | * @param ContactCenter $postBody
|
---|
132 | * @param array $optParams Optional parameters.
|
---|
133 | *
|
---|
134 | * @opt_param string requestId Optional. An optional request ID to identify
|
---|
135 | * requests. Specify a unique request ID so that if you must retry your request,
|
---|
136 | * the server will know to ignore the request if it has already been completed.
|
---|
137 | * The server will guarantee that for at least 60 minutes since the first
|
---|
138 | * request. For example, consider a situation where you make an initial request
|
---|
139 | * and the request times out. If you make the request again with the same
|
---|
140 | * request ID, the server can check if original operation with the same request
|
---|
141 | * ID was received, and if so, will ignore the second request. This prevents
|
---|
142 | * clients from accidentally creating duplicate commitments. The request ID must
|
---|
143 | * be a valid UUID with the exception that zero UUID is not supported
|
---|
144 | * (00000000-0000-0000-0000-000000000000).
|
---|
145 | * @opt_param string updateMask Required. Field mask is used to specify the
|
---|
146 | * fields to be overwritten in the ContactCenter resource by the update. The
|
---|
147 | * fields specified in the update_mask are relative to the resource, not the
|
---|
148 | * full request. A field will be overwritten if it is in the mask. If the user
|
---|
149 | * does not provide a mask then all fields will be overwritten.
|
---|
150 | * @return Operation
|
---|
151 | * @throws \Google\Service\Exception
|
---|
152 | */
|
---|
153 | public function patch($name, ContactCenter $postBody, $optParams = [])
|
---|
154 | {
|
---|
155 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
156 | $params = array_merge($params, $optParams);
|
---|
157 | return $this->call('patch', [$params], Operation::class);
|
---|
158 | }
|
---|
159 | }
|
---|
160 |
|
---|
161 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
162 | class_alias(ProjectsLocationsContactCenters::class, 'Google_Service_CCAIPlatform_Resource_ProjectsLocationsContactCenters');
|
---|