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\Contactcenterinsights\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Contactcenterinsights\GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse;
|
---|
21 | use Google\Service\Contactcenterinsights\GoogleCloudContactcenterinsightsV1QaScorecard;
|
---|
22 | use Google\Service\Contactcenterinsights\GoogleProtobufEmpty;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "qaScorecards" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $contactcenterinsightsService = new Google\Service\Contactcenterinsights(...);
|
---|
29 | * $qaScorecards = $contactcenterinsightsService->projects_locations_qaScorecards;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsQaScorecards extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Create a QaScorecard. (qaScorecards.create)
|
---|
36 | *
|
---|
37 | * @param string $parent Required. The parent resource of the QaScorecard.
|
---|
38 | * @param GoogleCloudContactcenterinsightsV1QaScorecard $postBody
|
---|
39 | * @param array $optParams Optional parameters.
|
---|
40 | *
|
---|
41 | * @opt_param string qaScorecardId Optional. A unique ID for the new
|
---|
42 | * QaScorecard. This ID will become the final component of the QaScorecard's
|
---|
43 | * resource name. If no ID is specified, a server-generated ID will be used.
|
---|
44 | * This value should be 4-64 characters and must match the regular expression
|
---|
45 | * `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
|
---|
46 | * @return GoogleCloudContactcenterinsightsV1QaScorecard
|
---|
47 | * @throws \Google\Service\Exception
|
---|
48 | */
|
---|
49 | public function create($parent, GoogleCloudContactcenterinsightsV1QaScorecard $postBody, $optParams = [])
|
---|
50 | {
|
---|
51 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
52 | $params = array_merge($params, $optParams);
|
---|
53 | return $this->call('create', [$params], GoogleCloudContactcenterinsightsV1QaScorecard::class);
|
---|
54 | }
|
---|
55 | /**
|
---|
56 | * Deletes a QaScorecard. (qaScorecards.delete)
|
---|
57 | *
|
---|
58 | * @param string $name Required. The name of the QaScorecard to delete.
|
---|
59 | * @param array $optParams Optional parameters.
|
---|
60 | *
|
---|
61 | * @opt_param bool force Optional. If set to true, all of this QaScorecard's
|
---|
62 | * child resources will also be deleted. Otherwise, the request will only
|
---|
63 | * succeed if it has none.
|
---|
64 | * @return GoogleProtobufEmpty
|
---|
65 | * @throws \Google\Service\Exception
|
---|
66 | */
|
---|
67 | public function delete($name, $optParams = [])
|
---|
68 | {
|
---|
69 | $params = ['name' => $name];
|
---|
70 | $params = array_merge($params, $optParams);
|
---|
71 | return $this->call('delete', [$params], GoogleProtobufEmpty::class);
|
---|
72 | }
|
---|
73 | /**
|
---|
74 | * Gets a QaScorecard. (qaScorecards.get)
|
---|
75 | *
|
---|
76 | * @param string $name Required. The name of the QaScorecard to get.
|
---|
77 | * @param array $optParams Optional parameters.
|
---|
78 | * @return GoogleCloudContactcenterinsightsV1QaScorecard
|
---|
79 | * @throws \Google\Service\Exception
|
---|
80 | */
|
---|
81 | public function get($name, $optParams = [])
|
---|
82 | {
|
---|
83 | $params = ['name' => $name];
|
---|
84 | $params = array_merge($params, $optParams);
|
---|
85 | return $this->call('get', [$params], GoogleCloudContactcenterinsightsV1QaScorecard::class);
|
---|
86 | }
|
---|
87 | /**
|
---|
88 | * Lists QaScorecards. (qaScorecards.listProjectsLocationsQaScorecards)
|
---|
89 | *
|
---|
90 | * @param string $parent Required. The parent resource of the scorecards.
|
---|
91 | * @param array $optParams Optional parameters.
|
---|
92 | *
|
---|
93 | * @opt_param int pageSize Optional. The maximum number of scorecards to return
|
---|
94 | * in the response. If the value is zero, the service will select a default
|
---|
95 | * size. A call might return fewer objects than requested. A non-empty
|
---|
96 | * `next_page_token` in the response indicates that more data is available.
|
---|
97 | * @opt_param string pageToken Optional. The value returned by the last
|
---|
98 | * `ListQaScorecardsResponse`. This value indicates that this is a continuation
|
---|
99 | * of a prior `ListQaScorecards` call and that the system should return the next
|
---|
100 | * page of data.
|
---|
101 | * @return GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse
|
---|
102 | * @throws \Google\Service\Exception
|
---|
103 | */
|
---|
104 | public function listProjectsLocationsQaScorecards($parent, $optParams = [])
|
---|
105 | {
|
---|
106 | $params = ['parent' => $parent];
|
---|
107 | $params = array_merge($params, $optParams);
|
---|
108 | return $this->call('list', [$params], GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse::class);
|
---|
109 | }
|
---|
110 | /**
|
---|
111 | * Updates a QaScorecard. (qaScorecards.patch)
|
---|
112 | *
|
---|
113 | * @param string $name Identifier. The scorecard name. Format:
|
---|
114 | * projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
|
---|
115 | * @param GoogleCloudContactcenterinsightsV1QaScorecard $postBody
|
---|
116 | * @param array $optParams Optional parameters.
|
---|
117 | *
|
---|
118 | * @opt_param string updateMask Required. The list of fields to be updated. All
|
---|
119 | * possible fields can be updated by passing `*`, or a subset of the following
|
---|
120 | * updateable fields can be provided: * `description` * `display_name`
|
---|
121 | * @return GoogleCloudContactcenterinsightsV1QaScorecard
|
---|
122 | * @throws \Google\Service\Exception
|
---|
123 | */
|
---|
124 | public function patch($name, GoogleCloudContactcenterinsightsV1QaScorecard $postBody, $optParams = [])
|
---|
125 | {
|
---|
126 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
127 | $params = array_merge($params, $optParams);
|
---|
128 | return $this->call('patch', [$params], GoogleCloudContactcenterinsightsV1QaScorecard::class);
|
---|
129 | }
|
---|
130 | }
|
---|
131 |
|
---|
132 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
133 | class_alias(ProjectsLocationsQaScorecards::class, 'Google_Service_Contactcenterinsights_Resource_ProjectsLocationsQaScorecards');
|
---|