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\GoogleCloudContactcenterinsightsV1AnalysisRule;
|
---|
21 | use Google\Service\Contactcenterinsights\GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse;
|
---|
22 | use Google\Service\Contactcenterinsights\GoogleProtobufEmpty;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "analysisRules" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $contactcenterinsightsService = new Google\Service\Contactcenterinsights(...);
|
---|
29 | * $analysisRules = $contactcenterinsightsService->projects_locations_analysisRules;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsAnalysisRules extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a analysis rule. (analysisRules.create)
|
---|
36 | *
|
---|
37 | * @param string $parent Required. The parent resource of the analysis rule.
|
---|
38 | * Required. The location to create a analysis rule for. Format:
|
---|
39 | * `projects//locations/` or `projects//locations/`
|
---|
40 | * @param GoogleCloudContactcenterinsightsV1AnalysisRule $postBody
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | * @return GoogleCloudContactcenterinsightsV1AnalysisRule
|
---|
43 | * @throws \Google\Service\Exception
|
---|
44 | */
|
---|
45 | public function create($parent, GoogleCloudContactcenterinsightsV1AnalysisRule $postBody, $optParams = [])
|
---|
46 | {
|
---|
47 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
48 | $params = array_merge($params, $optParams);
|
---|
49 | return $this->call('create', [$params], GoogleCloudContactcenterinsightsV1AnalysisRule::class);
|
---|
50 | }
|
---|
51 | /**
|
---|
52 | * Deletes a analysis rule. (analysisRules.delete)
|
---|
53 | *
|
---|
54 | * @param string $name Required. The name of the analysis rule to delete.
|
---|
55 | * @param array $optParams Optional parameters.
|
---|
56 | * @return GoogleProtobufEmpty
|
---|
57 | * @throws \Google\Service\Exception
|
---|
58 | */
|
---|
59 | public function delete($name, $optParams = [])
|
---|
60 | {
|
---|
61 | $params = ['name' => $name];
|
---|
62 | $params = array_merge($params, $optParams);
|
---|
63 | return $this->call('delete', [$params], GoogleProtobufEmpty::class);
|
---|
64 | }
|
---|
65 | /**
|
---|
66 | * Get a analysis rule. (analysisRules.get)
|
---|
67 | *
|
---|
68 | * @param string $name Required. The name of the AnalysisRule to get.
|
---|
69 | * @param array $optParams Optional parameters.
|
---|
70 | * @return GoogleCloudContactcenterinsightsV1AnalysisRule
|
---|
71 | * @throws \Google\Service\Exception
|
---|
72 | */
|
---|
73 | public function get($name, $optParams = [])
|
---|
74 | {
|
---|
75 | $params = ['name' => $name];
|
---|
76 | $params = array_merge($params, $optParams);
|
---|
77 | return $this->call('get', [$params], GoogleCloudContactcenterinsightsV1AnalysisRule::class);
|
---|
78 | }
|
---|
79 | /**
|
---|
80 | * Lists analysis rules. (analysisRules.listProjectsLocationsAnalysisRules)
|
---|
81 | *
|
---|
82 | * @param string $parent Required. The parent resource of the analysis rules.
|
---|
83 | * @param array $optParams Optional parameters.
|
---|
84 | *
|
---|
85 | * @opt_param int pageSize Optional. The maximum number of analysis rule to
|
---|
86 | * return in the response. If this value is zero, the service will select a
|
---|
87 | * default size. A call may return fewer objects than requested. A non-empty
|
---|
88 | * `next_page_token` in the response indicates that more data is available.
|
---|
89 | * @opt_param string pageToken Optional. The value returned by the last
|
---|
90 | * `ListAnalysisRulesResponse`; indicates that this is a continuation of a prior
|
---|
91 | * `ListAnalysisRules` call and the system should return the next page of data.
|
---|
92 | * @return GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse
|
---|
93 | * @throws \Google\Service\Exception
|
---|
94 | */
|
---|
95 | public function listProjectsLocationsAnalysisRules($parent, $optParams = [])
|
---|
96 | {
|
---|
97 | $params = ['parent' => $parent];
|
---|
98 | $params = array_merge($params, $optParams);
|
---|
99 | return $this->call('list', [$params], GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse::class);
|
---|
100 | }
|
---|
101 | /**
|
---|
102 | * Updates a analysis rule. (analysisRules.patch)
|
---|
103 | *
|
---|
104 | * @param string $name Identifier. The resource name of the analysis rule.
|
---|
105 | * Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}
|
---|
106 | * @param GoogleCloudContactcenterinsightsV1AnalysisRule $postBody
|
---|
107 | * @param array $optParams Optional parameters.
|
---|
108 | *
|
---|
109 | * @opt_param string updateMask Optional. The list of fields to be updated. If
|
---|
110 | * the update_mask is not provided, the update will be applied to all fields.
|
---|
111 | * @return GoogleCloudContactcenterinsightsV1AnalysisRule
|
---|
112 | * @throws \Google\Service\Exception
|
---|
113 | */
|
---|
114 | public function patch($name, GoogleCloudContactcenterinsightsV1AnalysisRule $postBody, $optParams = [])
|
---|
115 | {
|
---|
116 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
117 | $params = array_merge($params, $optParams);
|
---|
118 | return $this->call('patch', [$params], GoogleCloudContactcenterinsightsV1AnalysisRule::class);
|
---|
119 | }
|
---|
120 | }
|
---|
121 |
|
---|
122 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
123 | class_alias(ProjectsLocationsAnalysisRules::class, 'Google_Service_Contactcenterinsights_Resource_ProjectsLocationsAnalysisRules');
|
---|