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\GoogleCloudContactcenterinsightsV1Analysis;
|
---|
21 | use Google\Service\Contactcenterinsights\GoogleCloudContactcenterinsightsV1ListAnalysesResponse;
|
---|
22 | use Google\Service\Contactcenterinsights\GoogleLongrunningOperation;
|
---|
23 | use Google\Service\Contactcenterinsights\GoogleProtobufEmpty;
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * The "analyses" collection of methods.
|
---|
27 | * Typical usage is:
|
---|
28 | * <code>
|
---|
29 | * $contactcenterinsightsService = new Google\Service\Contactcenterinsights(...);
|
---|
30 | * $analyses = $contactcenterinsightsService->projects_locations_conversations_analyses;
|
---|
31 | * </code>
|
---|
32 | */
|
---|
33 | class ProjectsLocationsConversationsAnalyses extends \Google\Service\Resource
|
---|
34 | {
|
---|
35 | /**
|
---|
36 | * Creates an analysis. The long running operation is done when the analysis has
|
---|
37 | * completed. (analyses.create)
|
---|
38 | *
|
---|
39 | * @param string $parent Required. The parent resource of the analysis.
|
---|
40 | * @param GoogleCloudContactcenterinsightsV1Analysis $postBody
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | * @return GoogleLongrunningOperation
|
---|
43 | * @throws \Google\Service\Exception
|
---|
44 | */
|
---|
45 | public function create($parent, GoogleCloudContactcenterinsightsV1Analysis $postBody, $optParams = [])
|
---|
46 | {
|
---|
47 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
48 | $params = array_merge($params, $optParams);
|
---|
49 | return $this->call('create', [$params], GoogleLongrunningOperation::class);
|
---|
50 | }
|
---|
51 | /**
|
---|
52 | * Deletes an analysis. (analyses.delete)
|
---|
53 | *
|
---|
54 | * @param string $name Required. The name of the analysis 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 | * Gets an analysis. (analyses.get)
|
---|
67 | *
|
---|
68 | * @param string $name Required. The name of the analysis to get.
|
---|
69 | * @param array $optParams Optional parameters.
|
---|
70 | * @return GoogleCloudContactcenterinsightsV1Analysis
|
---|
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], GoogleCloudContactcenterinsightsV1Analysis::class);
|
---|
78 | }
|
---|
79 | /**
|
---|
80 | * Lists analyses. (analyses.listProjectsLocationsConversationsAnalyses)
|
---|
81 | *
|
---|
82 | * @param string $parent Required. The parent resource of the analyses.
|
---|
83 | * @param array $optParams Optional parameters.
|
---|
84 | *
|
---|
85 | * @opt_param string filter A filter to reduce results to a specific subset.
|
---|
86 | * Useful for querying conversations with specific properties.
|
---|
87 | * @opt_param int pageSize The maximum number of analyses to return in the
|
---|
88 | * response. If this value is zero, the service will select a default size. A
|
---|
89 | * call might return fewer objects than requested. A non-empty `next_page_token`
|
---|
90 | * in the response indicates that more data is available.
|
---|
91 | * @opt_param string pageToken The value returned by the last
|
---|
92 | * `ListAnalysesResponse`; indicates that this is a continuation of a prior
|
---|
93 | * `ListAnalyses` call and the system should return the next page of data.
|
---|
94 | * @return GoogleCloudContactcenterinsightsV1ListAnalysesResponse
|
---|
95 | * @throws \Google\Service\Exception
|
---|
96 | */
|
---|
97 | public function listProjectsLocationsConversationsAnalyses($parent, $optParams = [])
|
---|
98 | {
|
---|
99 | $params = ['parent' => $parent];
|
---|
100 | $params = array_merge($params, $optParams);
|
---|
101 | return $this->call('list', [$params], GoogleCloudContactcenterinsightsV1ListAnalysesResponse::class);
|
---|
102 | }
|
---|
103 | }
|
---|
104 |
|
---|
105 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
106 | class_alias(ProjectsLocationsConversationsAnalyses::class, 'Google_Service_Contactcenterinsights_Resource_ProjectsLocationsConversationsAnalyses');
|
---|