google-apis-contactcenterinsights_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1134 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module ContactcenterinsightsV1
23
+ # Contact Center AI Insights API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/contactcenterinsights_v1'
29
+ #
30
+ # Contactcenterinsights = Google::Apis::ContactcenterinsightsV1 # Alias the module
31
+ # service = Contactcenterinsights::ContactcenterinsightsService.new
32
+ #
33
+ # @see https://cloud.google.com/contact-center/insights/docs
34
+ class ContactcenterinsightsService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://contactcenterinsights.googleapis.com/', '',
47
+ client_name: 'google-apis-contactcenterinsights_v1',
48
+ client_version: Google::Apis::ContactcenterinsightsV1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Gets project-level settings.
53
+ # @param [String] name
54
+ # Required. The name of the settings resource to get.
55
+ # @param [String] fields
56
+ # Selector specifying which fields to include in a partial response.
57
+ # @param [String] quota_user
58
+ # Available to use for quota purposes for server-side applications. Can be any
59
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
60
+ # @param [Google::Apis::RequestOptions] options
61
+ # Request-specific options
62
+ #
63
+ # @yield [result, err] Result & error if block supplied
64
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings] parsed result object
65
+ # @yieldparam err [StandardError] error object if request failed
66
+ #
67
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings]
68
+ #
69
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
70
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
71
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
72
+ def get_project_location_settings(name, fields: nil, quota_user: nil, options: nil, &block)
73
+ command = make_simple_command(:get, 'v1/{+name}', options)
74
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings::Representation
75
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings
76
+ command.params['name'] = name unless name.nil?
77
+ command.query['fields'] = fields unless fields.nil?
78
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
79
+ execute_or_queue_command(command, &block)
80
+ end
81
+
82
+ # Updates project-level settings.
83
+ # @param [String] name
84
+ # Immutable. The resource name of the settings resource. Format: projects/`
85
+ # project`/locations/`location`/settings
86
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings] google_cloud_contactcenterinsights_v1_settings_object
87
+ # @param [String] update_mask
88
+ # Required. The list of fields to be updated.
89
+ # @param [String] fields
90
+ # Selector specifying which fields to include in a partial response.
91
+ # @param [String] quota_user
92
+ # Available to use for quota purposes for server-side applications. Can be any
93
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
94
+ # @param [Google::Apis::RequestOptions] options
95
+ # Request-specific options
96
+ #
97
+ # @yield [result, err] Result & error if block supplied
98
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings] parsed result object
99
+ # @yieldparam err [StandardError] error object if request failed
100
+ #
101
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings]
102
+ #
103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
106
+ def update_project_location_settings(name, google_cloud_contactcenterinsights_v1_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
107
+ command = make_simple_command(:patch, 'v1/{+name}', options)
108
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings::Representation
109
+ command.request_object = google_cloud_contactcenterinsights_v1_settings_object
110
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings::Representation
111
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Settings
112
+ command.params['name'] = name unless name.nil?
113
+ command.query['updateMask'] = update_mask unless update_mask.nil?
114
+ command.query['fields'] = fields unless fields.nil?
115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
116
+ execute_or_queue_command(command, &block)
117
+ end
118
+
119
+ # Gets conversation statistics.
120
+ # @param [String] location
121
+ # Required. The location of the conversations.
122
+ # @param [String] filter
123
+ # A filter to reduce results to a specific subset. This field is useful for
124
+ # getting statistics about conversations with specific properties.
125
+ # @param [String] fields
126
+ # Selector specifying which fields to include in a partial response.
127
+ # @param [String] quota_user
128
+ # Available to use for quota purposes for server-side applications. Can be any
129
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
130
+ # @param [Google::Apis::RequestOptions] options
131
+ # Request-specific options
132
+ #
133
+ # @yield [result, err] Result & error if block supplied
134
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateStatsResponse] parsed result object
135
+ # @yieldparam err [StandardError] error object if request failed
136
+ #
137
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateStatsResponse]
138
+ #
139
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
140
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
141
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
142
+ def calculate_project_location_conversation_stats(location, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
143
+ command = make_simple_command(:get, 'v1/{+location}/conversations:calculateStats', options)
144
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateStatsResponse::Representation
145
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateStatsResponse
146
+ command.params['location'] = location unless location.nil?
147
+ command.query['filter'] = filter unless filter.nil?
148
+ command.query['fields'] = fields unless fields.nil?
149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
150
+ execute_or_queue_command(command, &block)
151
+ end
152
+
153
+ # Creates a conversation.
154
+ # @param [String] parent
155
+ # Required. The parent resource of the conversation.
156
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation] google_cloud_contactcenterinsights_v1_conversation_object
157
+ # @param [String] conversation_id
158
+ # A unique ID for the new conversation. This ID will become the final component
159
+ # of the conversation's resource name. If no ID is specified, a server-generated
160
+ # ID will be used. This value should be 4-32 characters and must match the
161
+ # regular expression /^[a-z0-9-]`4,32`$/. Valid characters are /a-z-/
162
+ # @param [String] fields
163
+ # Selector specifying which fields to include in a partial response.
164
+ # @param [String] quota_user
165
+ # Available to use for quota purposes for server-side applications. Can be any
166
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
167
+ # @param [Google::Apis::RequestOptions] options
168
+ # Request-specific options
169
+ #
170
+ # @yield [result, err] Result & error if block supplied
171
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation] parsed result object
172
+ # @yieldparam err [StandardError] error object if request failed
173
+ #
174
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation]
175
+ #
176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
179
+ def create_project_location_conversation(parent, google_cloud_contactcenterinsights_v1_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
180
+ command = make_simple_command(:post, 'v1/{+parent}/conversations', options)
181
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation::Representation
182
+ command.request_object = google_cloud_contactcenterinsights_v1_conversation_object
183
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation::Representation
184
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation
185
+ command.params['parent'] = parent unless parent.nil?
186
+ command.query['conversationId'] = conversation_id unless conversation_id.nil?
187
+ command.query['fields'] = fields unless fields.nil?
188
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
189
+ execute_or_queue_command(command, &block)
190
+ end
191
+
192
+ # Deletes a conversation.
193
+ # @param [String] name
194
+ # Required. The name of the conversation to delete.
195
+ # @param [Boolean] force
196
+ # If set to true, all of this conversation's analyses will also be deleted.
197
+ # Otherwise, the request will only succeed if the conversation has no analyses.
198
+ # @param [String] fields
199
+ # Selector specifying which fields to include in a partial response.
200
+ # @param [String] quota_user
201
+ # Available to use for quota purposes for server-side applications. Can be any
202
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
203
+ # @param [Google::Apis::RequestOptions] options
204
+ # Request-specific options
205
+ #
206
+ # @yield [result, err] Result & error if block supplied
207
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty] parsed result object
208
+ # @yieldparam err [StandardError] error object if request failed
209
+ #
210
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty]
211
+ #
212
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
213
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
214
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
215
+ def delete_project_location_conversation(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
216
+ command = make_simple_command(:delete, 'v1/{+name}', options)
217
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty::Representation
218
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty
219
+ command.params['name'] = name unless name.nil?
220
+ command.query['force'] = force unless force.nil?
221
+ command.query['fields'] = fields unless fields.nil?
222
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
223
+ execute_or_queue_command(command, &block)
224
+ end
225
+
226
+ # Gets a conversation.
227
+ # @param [String] name
228
+ # Required. The name of the conversation to get.
229
+ # @param [String] view
230
+ # The level of details of the conversation. Default is `FULL`.
231
+ # @param [String] fields
232
+ # Selector specifying which fields to include in a partial response.
233
+ # @param [String] quota_user
234
+ # Available to use for quota purposes for server-side applications. Can be any
235
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
236
+ # @param [Google::Apis::RequestOptions] options
237
+ # Request-specific options
238
+ #
239
+ # @yield [result, err] Result & error if block supplied
240
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation] parsed result object
241
+ # @yieldparam err [StandardError] error object if request failed
242
+ #
243
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation]
244
+ #
245
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
246
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
247
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
248
+ def get_project_location_conversation(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
249
+ command = make_simple_command(:get, 'v1/{+name}', options)
250
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation::Representation
251
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation
252
+ command.params['name'] = name unless name.nil?
253
+ command.query['view'] = view unless view.nil?
254
+ command.query['fields'] = fields unless fields.nil?
255
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
256
+ execute_or_queue_command(command, &block)
257
+ end
258
+
259
+ # Lists conversations.
260
+ # @param [String] parent
261
+ # Required. The parent resource of the conversation.
262
+ # @param [String] filter
263
+ # A filter to reduce results to a specific subset. Useful for querying
264
+ # conversations with specific properties.
265
+ # @param [Fixnum] page_size
266
+ # The maximum number of conversations to return in the response. A valid page
267
+ # size ranges from 0 to 1,000 inclusive. If the page size is zero or unspecified,
268
+ # a default page size of 100 will be chosen. Note that a call might return
269
+ # fewer results than the requested page size.
270
+ # @param [String] page_token
271
+ # The value returned by the last `ListConversationsResponse`. This value
272
+ # indicates that this is a continuation of a prior `ListConversations` call and
273
+ # that the system should return the next page of data.
274
+ # @param [String] view
275
+ # The level of details of the conversation. Default is `BASIC`.
276
+ # @param [String] fields
277
+ # Selector specifying which fields to include in a partial response.
278
+ # @param [String] quota_user
279
+ # Available to use for quota purposes for server-side applications. Can be any
280
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
281
+ # @param [Google::Apis::RequestOptions] options
282
+ # Request-specific options
283
+ #
284
+ # @yield [result, err] Result & error if block supplied
285
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListConversationsResponse] parsed result object
286
+ # @yieldparam err [StandardError] error object if request failed
287
+ #
288
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListConversationsResponse]
289
+ #
290
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
291
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
292
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
293
+ def list_project_location_conversations(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
294
+ command = make_simple_command(:get, 'v1/{+parent}/conversations', options)
295
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListConversationsResponse::Representation
296
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListConversationsResponse
297
+ command.params['parent'] = parent unless parent.nil?
298
+ command.query['filter'] = filter unless filter.nil?
299
+ command.query['pageSize'] = page_size unless page_size.nil?
300
+ command.query['pageToken'] = page_token unless page_token.nil?
301
+ command.query['view'] = view unless view.nil?
302
+ command.query['fields'] = fields unless fields.nil?
303
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
304
+ execute_or_queue_command(command, &block)
305
+ end
306
+
307
+ # Updates a conversation.
308
+ # @param [String] name
309
+ # Immutable. The resource name of the conversation. Format: projects/`project`/
310
+ # locations/`location`/conversations/`conversation`
311
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation] google_cloud_contactcenterinsights_v1_conversation_object
312
+ # @param [String] update_mask
313
+ # The list of fields to be updated.
314
+ # @param [String] fields
315
+ # Selector specifying which fields to include in a partial response.
316
+ # @param [String] quota_user
317
+ # Available to use for quota purposes for server-side applications. Can be any
318
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
319
+ # @param [Google::Apis::RequestOptions] options
320
+ # Request-specific options
321
+ #
322
+ # @yield [result, err] Result & error if block supplied
323
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation] parsed result object
324
+ # @yieldparam err [StandardError] error object if request failed
325
+ #
326
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation]
327
+ #
328
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
329
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
330
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
331
+ def patch_project_location_conversation(name, google_cloud_contactcenterinsights_v1_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
332
+ command = make_simple_command(:patch, 'v1/{+name}', options)
333
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation::Representation
334
+ command.request_object = google_cloud_contactcenterinsights_v1_conversation_object
335
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation::Representation
336
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Conversation
337
+ command.params['name'] = name unless name.nil?
338
+ command.query['updateMask'] = update_mask unless update_mask.nil?
339
+ command.query['fields'] = fields unless fields.nil?
340
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
341
+ execute_or_queue_command(command, &block)
342
+ end
343
+
344
+ # Creates an analysis. The long running operation is done when the analysis has
345
+ # completed.
346
+ # @param [String] parent
347
+ # Required. The parent resource of the analysis.
348
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis] google_cloud_contactcenterinsights_v1_analysis_object
349
+ # @param [String] fields
350
+ # Selector specifying which fields to include in a partial response.
351
+ # @param [String] quota_user
352
+ # Available to use for quota purposes for server-side applications. Can be any
353
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
354
+ # @param [Google::Apis::RequestOptions] options
355
+ # Request-specific options
356
+ #
357
+ # @yield [result, err] Result & error if block supplied
358
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
359
+ # @yieldparam err [StandardError] error object if request failed
360
+ #
361
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
362
+ #
363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
366
+ def create_project_location_conversation_analysis(parent, google_cloud_contactcenterinsights_v1_analysis_object = nil, fields: nil, quota_user: nil, options: nil, &block)
367
+ command = make_simple_command(:post, 'v1/{+parent}/analyses', options)
368
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis::Representation
369
+ command.request_object = google_cloud_contactcenterinsights_v1_analysis_object
370
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
371
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
372
+ command.params['parent'] = parent unless parent.nil?
373
+ command.query['fields'] = fields unless fields.nil?
374
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
375
+ execute_or_queue_command(command, &block)
376
+ end
377
+
378
+ # Deletes an analysis.
379
+ # @param [String] name
380
+ # Required. The name of the analysis to delete.
381
+ # @param [String] fields
382
+ # Selector specifying which fields to include in a partial response.
383
+ # @param [String] quota_user
384
+ # Available to use for quota purposes for server-side applications. Can be any
385
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
386
+ # @param [Google::Apis::RequestOptions] options
387
+ # Request-specific options
388
+ #
389
+ # @yield [result, err] Result & error if block supplied
390
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty] parsed result object
391
+ # @yieldparam err [StandardError] error object if request failed
392
+ #
393
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty]
394
+ #
395
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
396
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
397
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
398
+ def delete_project_location_conversation_analysis(name, fields: nil, quota_user: nil, options: nil, &block)
399
+ command = make_simple_command(:delete, 'v1/{+name}', options)
400
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty::Representation
401
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty
402
+ command.params['name'] = name unless name.nil?
403
+ command.query['fields'] = fields unless fields.nil?
404
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
405
+ execute_or_queue_command(command, &block)
406
+ end
407
+
408
+ # Gets an analysis.
409
+ # @param [String] name
410
+ # Required. The name of the analysis to get.
411
+ # @param [String] fields
412
+ # Selector specifying which fields to include in a partial response.
413
+ # @param [String] quota_user
414
+ # Available to use for quota purposes for server-side applications. Can be any
415
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
416
+ # @param [Google::Apis::RequestOptions] options
417
+ # Request-specific options
418
+ #
419
+ # @yield [result, err] Result & error if block supplied
420
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis] parsed result object
421
+ # @yieldparam err [StandardError] error object if request failed
422
+ #
423
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis]
424
+ #
425
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
426
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
427
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
428
+ def get_project_location_conversation_analysis(name, fields: nil, quota_user: nil, options: nil, &block)
429
+ command = make_simple_command(:get, 'v1/{+name}', options)
430
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis::Representation
431
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Analysis
432
+ command.params['name'] = name unless name.nil?
433
+ command.query['fields'] = fields unless fields.nil?
434
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
435
+ execute_or_queue_command(command, &block)
436
+ end
437
+
438
+ # Lists analyses.
439
+ # @param [String] parent
440
+ # Required. The parent resource of the analyses.
441
+ # @param [String] filter
442
+ # A filter to reduce results to a specific subset. Useful for querying
443
+ # conversations with specific properties.
444
+ # @param [Fixnum] page_size
445
+ # The maximum number of analyses to return in the response. If this value is
446
+ # zero, the service will select a default size. A call might return fewer
447
+ # objects than requested. A non-empty `next_page_token` in the response
448
+ # indicates that more data is available.
449
+ # @param [String] page_token
450
+ # The value returned by the last `ListAnalysesResponse`; indicates that this is
451
+ # a continuation of a prior `ListAnalyses` call and the system should return the
452
+ # next page of data.
453
+ # @param [String] fields
454
+ # Selector specifying which fields to include in a partial response.
455
+ # @param [String] quota_user
456
+ # Available to use for quota purposes for server-side applications. Can be any
457
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
458
+ # @param [Google::Apis::RequestOptions] options
459
+ # Request-specific options
460
+ #
461
+ # @yield [result, err] Result & error if block supplied
462
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListAnalysesResponse] parsed result object
463
+ # @yieldparam err [StandardError] error object if request failed
464
+ #
465
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListAnalysesResponse]
466
+ #
467
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
468
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
469
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
470
+ def list_project_location_conversation_analyses(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
471
+ command = make_simple_command(:get, 'v1/{+parent}/analyses', options)
472
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListAnalysesResponse::Representation
473
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListAnalysesResponse
474
+ command.params['parent'] = parent unless parent.nil?
475
+ command.query['filter'] = filter unless filter.nil?
476
+ command.query['pageSize'] = page_size unless page_size.nil?
477
+ command.query['pageToken'] = page_token unless page_token.nil?
478
+ command.query['fields'] = fields unless fields.nil?
479
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
480
+ execute_or_queue_command(command, &block)
481
+ end
482
+
483
+ # Export insights data to a destination defined in the request body.
484
+ # @param [String] parent
485
+ # Required. The parent resource to export data from.
486
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest] google_cloud_contactcenterinsights_v1_export_insights_data_request_object
487
+ # @param [String] fields
488
+ # Selector specifying which fields to include in a partial response.
489
+ # @param [String] quota_user
490
+ # Available to use for quota purposes for server-side applications. Can be any
491
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
492
+ # @param [Google::Apis::RequestOptions] options
493
+ # Request-specific options
494
+ #
495
+ # @yield [result, err] Result & error if block supplied
496
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
497
+ # @yieldparam err [StandardError] error object if request failed
498
+ #
499
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
500
+ #
501
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
502
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
503
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
504
+ def export_project_location_insightsdatum(parent, google_cloud_contactcenterinsights_v1_export_insights_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
505
+ command = make_simple_command(:post, 'v1/{+parent}/insightsdata:export', options)
506
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest::Representation
507
+ command.request_object = google_cloud_contactcenterinsights_v1_export_insights_data_request_object
508
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
509
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
510
+ command.params['parent'] = parent unless parent.nil?
511
+ command.query['fields'] = fields unless fields.nil?
512
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
513
+ execute_or_queue_command(command, &block)
514
+ end
515
+
516
+ # Gets an issue model's statistics.
517
+ # @param [String] issue_model
518
+ # Required. The resource name of the issue model to query against.
519
+ # @param [String] fields
520
+ # Selector specifying which fields to include in a partial response.
521
+ # @param [String] quota_user
522
+ # Available to use for quota purposes for server-side applications. Can be any
523
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
524
+ # @param [Google::Apis::RequestOptions] options
525
+ # Request-specific options
526
+ #
527
+ # @yield [result, err] Result & error if block supplied
528
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse] parsed result object
529
+ # @yieldparam err [StandardError] error object if request failed
530
+ #
531
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse]
532
+ #
533
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
534
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
535
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
536
+ def calculate_project_location_issue_model_issue_model_stats(issue_model, fields: nil, quota_user: nil, options: nil, &block)
537
+ command = make_simple_command(:get, 'v1/{+issueModel}:calculateIssueModelStats', options)
538
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse::Representation
539
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse
540
+ command.params['issueModel'] = issue_model unless issue_model.nil?
541
+ command.query['fields'] = fields unless fields.nil?
542
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
543
+ execute_or_queue_command(command, &block)
544
+ end
545
+
546
+ # Creates an issue model.
547
+ # @param [String] parent
548
+ # Required. The parent resource of the issue model.
549
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel] google_cloud_contactcenterinsights_v1_issue_model_object
550
+ # @param [String] fields
551
+ # Selector specifying which fields to include in a partial response.
552
+ # @param [String] quota_user
553
+ # Available to use for quota purposes for server-side applications. Can be any
554
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
555
+ # @param [Google::Apis::RequestOptions] options
556
+ # Request-specific options
557
+ #
558
+ # @yield [result, err] Result & error if block supplied
559
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
560
+ # @yieldparam err [StandardError] error object if request failed
561
+ #
562
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
563
+ #
564
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
565
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
566
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
567
+ def create_project_location_issue_model(parent, google_cloud_contactcenterinsights_v1_issue_model_object = nil, fields: nil, quota_user: nil, options: nil, &block)
568
+ command = make_simple_command(:post, 'v1/{+parent}/issueModels', options)
569
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel::Representation
570
+ command.request_object = google_cloud_contactcenterinsights_v1_issue_model_object
571
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
572
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
573
+ command.params['parent'] = parent unless parent.nil?
574
+ command.query['fields'] = fields unless fields.nil?
575
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
576
+ execute_or_queue_command(command, &block)
577
+ end
578
+
579
+ # Deletes an issue model.
580
+ # @param [String] name
581
+ # Required. The name of the issue model to delete.
582
+ # @param [String] fields
583
+ # Selector specifying which fields to include in a partial response.
584
+ # @param [String] quota_user
585
+ # Available to use for quota purposes for server-side applications. Can be any
586
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
587
+ # @param [Google::Apis::RequestOptions] options
588
+ # Request-specific options
589
+ #
590
+ # @yield [result, err] Result & error if block supplied
591
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
592
+ # @yieldparam err [StandardError] error object if request failed
593
+ #
594
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
595
+ #
596
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
597
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
598
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
599
+ def delete_project_location_issue_model(name, fields: nil, quota_user: nil, options: nil, &block)
600
+ command = make_simple_command(:delete, 'v1/{+name}', options)
601
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
602
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
603
+ command.params['name'] = name unless name.nil?
604
+ command.query['fields'] = fields unless fields.nil?
605
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
606
+ execute_or_queue_command(command, &block)
607
+ end
608
+
609
+ # Deploys an issue model. Returns an error if a model is already deployed. An
610
+ # issue model can only be used in analysis after it has been deployed.
611
+ # @param [String] name
612
+ # Required. The issue model to deploy.
613
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1DeployIssueModelRequest] google_cloud_contactcenterinsights_v1_deploy_issue_model_request_object
614
+ # @param [String] fields
615
+ # Selector specifying which fields to include in a partial response.
616
+ # @param [String] quota_user
617
+ # Available to use for quota purposes for server-side applications. Can be any
618
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
619
+ # @param [Google::Apis::RequestOptions] options
620
+ # Request-specific options
621
+ #
622
+ # @yield [result, err] Result & error if block supplied
623
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
624
+ # @yieldparam err [StandardError] error object if request failed
625
+ #
626
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
627
+ #
628
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
629
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
630
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
631
+ def deploy_project_location_issue_model(name, google_cloud_contactcenterinsights_v1_deploy_issue_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
632
+ command = make_simple_command(:post, 'v1/{+name}:deploy', options)
633
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1DeployIssueModelRequest::Representation
634
+ command.request_object = google_cloud_contactcenterinsights_v1_deploy_issue_model_request_object
635
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
636
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
637
+ command.params['name'] = name unless name.nil?
638
+ command.query['fields'] = fields unless fields.nil?
639
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
640
+ execute_or_queue_command(command, &block)
641
+ end
642
+
643
+ # Gets an issue model.
644
+ # @param [String] name
645
+ # Required. The name of the issue model to get.
646
+ # @param [String] fields
647
+ # Selector specifying which fields to include in a partial response.
648
+ # @param [String] quota_user
649
+ # Available to use for quota purposes for server-side applications. Can be any
650
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
651
+ # @param [Google::Apis::RequestOptions] options
652
+ # Request-specific options
653
+ #
654
+ # @yield [result, err] Result & error if block supplied
655
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel] parsed result object
656
+ # @yieldparam err [StandardError] error object if request failed
657
+ #
658
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel]
659
+ #
660
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
661
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
662
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
663
+ def get_project_location_issue_model(name, fields: nil, quota_user: nil, options: nil, &block)
664
+ command = make_simple_command(:get, 'v1/{+name}', options)
665
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel::Representation
666
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel
667
+ command.params['name'] = name unless name.nil?
668
+ command.query['fields'] = fields unless fields.nil?
669
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
670
+ execute_or_queue_command(command, &block)
671
+ end
672
+
673
+ # Lists issue models.
674
+ # @param [String] parent
675
+ # Required. The parent resource of the issue model.
676
+ # @param [String] fields
677
+ # Selector specifying which fields to include in a partial response.
678
+ # @param [String] quota_user
679
+ # Available to use for quota purposes for server-side applications. Can be any
680
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
681
+ # @param [Google::Apis::RequestOptions] options
682
+ # Request-specific options
683
+ #
684
+ # @yield [result, err] Result & error if block supplied
685
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssueModelsResponse] parsed result object
686
+ # @yieldparam err [StandardError] error object if request failed
687
+ #
688
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssueModelsResponse]
689
+ #
690
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
691
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
692
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
693
+ def list_project_location_issue_models(parent, fields: nil, quota_user: nil, options: nil, &block)
694
+ command = make_simple_command(:get, 'v1/{+parent}/issueModels', options)
695
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssueModelsResponse::Representation
696
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssueModelsResponse
697
+ command.params['parent'] = parent unless parent.nil?
698
+ command.query['fields'] = fields unless fields.nil?
699
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
700
+ execute_or_queue_command(command, &block)
701
+ end
702
+
703
+ # Updates an issue model.
704
+ # @param [String] name
705
+ # Immutable. The resource name of the issue model. Format: projects/`project`/
706
+ # locations/`location`/issueModels/`issue_model`
707
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel] google_cloud_contactcenterinsights_v1_issue_model_object
708
+ # @param [String] update_mask
709
+ # The list of fields to be updated.
710
+ # @param [String] fields
711
+ # Selector specifying which fields to include in a partial response.
712
+ # @param [String] quota_user
713
+ # Available to use for quota purposes for server-side applications. Can be any
714
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
715
+ # @param [Google::Apis::RequestOptions] options
716
+ # Request-specific options
717
+ #
718
+ # @yield [result, err] Result & error if block supplied
719
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel] parsed result object
720
+ # @yieldparam err [StandardError] error object if request failed
721
+ #
722
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel]
723
+ #
724
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
725
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
726
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
727
+ def patch_project_location_issue_model(name, google_cloud_contactcenterinsights_v1_issue_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
728
+ command = make_simple_command(:patch, 'v1/{+name}', options)
729
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel::Representation
730
+ command.request_object = google_cloud_contactcenterinsights_v1_issue_model_object
731
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel::Representation
732
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1IssueModel
733
+ command.params['name'] = name unless name.nil?
734
+ command.query['updateMask'] = update_mask unless update_mask.nil?
735
+ command.query['fields'] = fields unless fields.nil?
736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
737
+ execute_or_queue_command(command, &block)
738
+ end
739
+
740
+ # Undeploys an issue model. An issue model can not be used in analysis after it
741
+ # has been undeployed.
742
+ # @param [String] name
743
+ # Required. The issue model to undeploy.
744
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest] google_cloud_contactcenterinsights_v1_undeploy_issue_model_request_object
745
+ # @param [String] fields
746
+ # Selector specifying which fields to include in a partial response.
747
+ # @param [String] quota_user
748
+ # Available to use for quota purposes for server-side applications. Can be any
749
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
750
+ # @param [Google::Apis::RequestOptions] options
751
+ # Request-specific options
752
+ #
753
+ # @yield [result, err] Result & error if block supplied
754
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
755
+ # @yieldparam err [StandardError] error object if request failed
756
+ #
757
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
758
+ #
759
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
760
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
761
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
762
+ def undeploy_project_location_issue_model(name, google_cloud_contactcenterinsights_v1_undeploy_issue_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
763
+ command = make_simple_command(:post, 'v1/{+name}:undeploy', options)
764
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest::Representation
765
+ command.request_object = google_cloud_contactcenterinsights_v1_undeploy_issue_model_request_object
766
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
767
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
768
+ command.params['name'] = name unless name.nil?
769
+ command.query['fields'] = fields unless fields.nil?
770
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
771
+ execute_or_queue_command(command, &block)
772
+ end
773
+
774
+ # Gets an issue.
775
+ # @param [String] name
776
+ # Required. The name of the issue to get.
777
+ # @param [String] fields
778
+ # Selector specifying which fields to include in a partial response.
779
+ # @param [String] quota_user
780
+ # Available to use for quota purposes for server-side applications. Can be any
781
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
782
+ # @param [Google::Apis::RequestOptions] options
783
+ # Request-specific options
784
+ #
785
+ # @yield [result, err] Result & error if block supplied
786
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue] parsed result object
787
+ # @yieldparam err [StandardError] error object if request failed
788
+ #
789
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue]
790
+ #
791
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
792
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
793
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
794
+ def get_project_location_issue_model_issue(name, fields: nil, quota_user: nil, options: nil, &block)
795
+ command = make_simple_command(:get, 'v1/{+name}', options)
796
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue::Representation
797
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue
798
+ command.params['name'] = name unless name.nil?
799
+ command.query['fields'] = fields unless fields.nil?
800
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
801
+ execute_or_queue_command(command, &block)
802
+ end
803
+
804
+ # Lists issues.
805
+ # @param [String] parent
806
+ # Required. The parent resource of the issue.
807
+ # @param [String] fields
808
+ # Selector specifying which fields to include in a partial response.
809
+ # @param [String] quota_user
810
+ # Available to use for quota purposes for server-side applications. Can be any
811
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
812
+ # @param [Google::Apis::RequestOptions] options
813
+ # Request-specific options
814
+ #
815
+ # @yield [result, err] Result & error if block supplied
816
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssuesResponse] parsed result object
817
+ # @yieldparam err [StandardError] error object if request failed
818
+ #
819
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssuesResponse]
820
+ #
821
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
822
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
823
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
824
+ def list_project_location_issue_model_issues(parent, fields: nil, quota_user: nil, options: nil, &block)
825
+ command = make_simple_command(:get, 'v1/{+parent}/issues', options)
826
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssuesResponse::Representation
827
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListIssuesResponse
828
+ command.params['parent'] = parent unless parent.nil?
829
+ command.query['fields'] = fields unless fields.nil?
830
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
831
+ execute_or_queue_command(command, &block)
832
+ end
833
+
834
+ # Updates an issue.
835
+ # @param [String] name
836
+ # Immutable. The resource name of the issue. Format: projects/`project`/
837
+ # locations/`location`/issueModels/`issue_model`/issues/`issue`
838
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue] google_cloud_contactcenterinsights_v1_issue_object
839
+ # @param [String] update_mask
840
+ # The list of fields to be updated.
841
+ # @param [String] fields
842
+ # Selector specifying which fields to include in a partial response.
843
+ # @param [String] quota_user
844
+ # Available to use for quota purposes for server-side applications. Can be any
845
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
846
+ # @param [Google::Apis::RequestOptions] options
847
+ # Request-specific options
848
+ #
849
+ # @yield [result, err] Result & error if block supplied
850
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue] parsed result object
851
+ # @yieldparam err [StandardError] error object if request failed
852
+ #
853
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue]
854
+ #
855
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
856
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
857
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
858
+ def patch_project_location_issue_model_issue(name, google_cloud_contactcenterinsights_v1_issue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
859
+ command = make_simple_command(:patch, 'v1/{+name}', options)
860
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue::Representation
861
+ command.request_object = google_cloud_contactcenterinsights_v1_issue_object
862
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue::Representation
863
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1Issue
864
+ command.params['name'] = name unless name.nil?
865
+ command.query['updateMask'] = update_mask unless update_mask.nil?
866
+ command.query['fields'] = fields unless fields.nil?
867
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
868
+ execute_or_queue_command(command, &block)
869
+ end
870
+
871
+ # Starts asynchronous cancellation on a long-running operation. The server makes
872
+ # a best effort to cancel the operation, but success is not guaranteed. If the
873
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
874
+ # Clients can use Operations.GetOperation or other methods to check whether the
875
+ # cancellation succeeded or whether the operation completed despite cancellation.
876
+ # On successful cancellation, the operation is not deleted; instead, it becomes
877
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
878
+ # corresponding to `Code.CANCELLED`.
879
+ # @param [String] name
880
+ # The name of the operation resource to be cancelled.
881
+ # @param [String] fields
882
+ # Selector specifying which fields to include in a partial response.
883
+ # @param [String] quota_user
884
+ # Available to use for quota purposes for server-side applications. Can be any
885
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
886
+ # @param [Google::Apis::RequestOptions] options
887
+ # Request-specific options
888
+ #
889
+ # @yield [result, err] Result & error if block supplied
890
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty] parsed result object
891
+ # @yieldparam err [StandardError] error object if request failed
892
+ #
893
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty]
894
+ #
895
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
896
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
897
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
898
+ def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
899
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
900
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty::Representation
901
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty
902
+ command.params['name'] = name unless name.nil?
903
+ command.query['fields'] = fields unless fields.nil?
904
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
905
+ execute_or_queue_command(command, &block)
906
+ end
907
+
908
+ # Gets the latest state of a long-running operation. Clients can use this method
909
+ # to poll the operation result at intervals as recommended by the API service.
910
+ # @param [String] name
911
+ # The name of the operation resource.
912
+ # @param [String] fields
913
+ # Selector specifying which fields to include in a partial response.
914
+ # @param [String] quota_user
915
+ # Available to use for quota purposes for server-side applications. Can be any
916
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
917
+ # @param [Google::Apis::RequestOptions] options
918
+ # Request-specific options
919
+ #
920
+ # @yield [result, err] Result & error if block supplied
921
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation] parsed result object
922
+ # @yieldparam err [StandardError] error object if request failed
923
+ #
924
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation]
925
+ #
926
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
927
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
928
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
929
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
930
+ command = make_simple_command(:get, 'v1/{+name}', options)
931
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation::Representation
932
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningOperation
933
+ command.params['name'] = name unless name.nil?
934
+ command.query['fields'] = fields unless fields.nil?
935
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
936
+ execute_or_queue_command(command, &block)
937
+ end
938
+
939
+ # Lists operations that match the specified filter in the request. If the server
940
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
941
+ # binding allows API services to override the binding to use different resource
942
+ # name schemes, such as `users/*/operations`. To override the binding, API
943
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
944
+ # service configuration. For backwards compatibility, the default name includes
945
+ # the operations collection id, however overriding users must ensure the name
946
+ # binding is the parent resource, without the operations collection id.
947
+ # @param [String] name
948
+ # The name of the operation's parent resource.
949
+ # @param [String] filter
950
+ # The standard list filter.
951
+ # @param [Fixnum] page_size
952
+ # The standard list page size.
953
+ # @param [String] page_token
954
+ # The standard list page token.
955
+ # @param [String] fields
956
+ # Selector specifying which fields to include in a partial response.
957
+ # @param [String] quota_user
958
+ # Available to use for quota purposes for server-side applications. Can be any
959
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
960
+ # @param [Google::Apis::RequestOptions] options
961
+ # Request-specific options
962
+ #
963
+ # @yield [result, err] Result & error if block supplied
964
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningListOperationsResponse] parsed result object
965
+ # @yieldparam err [StandardError] error object if request failed
966
+ #
967
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleLongrunningListOperationsResponse]
968
+ #
969
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
970
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
971
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
972
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
973
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
974
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningListOperationsResponse::Representation
975
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleLongrunningListOperationsResponse
976
+ command.params['name'] = name unless name.nil?
977
+ command.query['filter'] = filter unless filter.nil?
978
+ command.query['pageSize'] = page_size unless page_size.nil?
979
+ command.query['pageToken'] = page_token unless page_token.nil?
980
+ command.query['fields'] = fields unless fields.nil?
981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
982
+ execute_or_queue_command(command, &block)
983
+ end
984
+
985
+ # Creates a phrase matcher.
986
+ # @param [String] parent
987
+ # Required. The parent resource of the phrase matcher. Required. The location to
988
+ # create a phrase matcher for. Format: `projects//locations/` or `projects//
989
+ # locations/`
990
+ # @param [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher] google_cloud_contactcenterinsights_v1_phrase_matcher_object
991
+ # @param [String] fields
992
+ # Selector specifying which fields to include in a partial response.
993
+ # @param [String] quota_user
994
+ # Available to use for quota purposes for server-side applications. Can be any
995
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
996
+ # @param [Google::Apis::RequestOptions] options
997
+ # Request-specific options
998
+ #
999
+ # @yield [result, err] Result & error if block supplied
1000
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher] parsed result object
1001
+ # @yieldparam err [StandardError] error object if request failed
1002
+ #
1003
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher]
1004
+ #
1005
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1006
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1007
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1008
+ def create_project_location_phrase_matcher(parent, google_cloud_contactcenterinsights_v1_phrase_matcher_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1009
+ command = make_simple_command(:post, 'v1/{+parent}/phraseMatchers', options)
1010
+ command.request_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher::Representation
1011
+ command.request_object = google_cloud_contactcenterinsights_v1_phrase_matcher_object
1012
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher::Representation
1013
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher
1014
+ command.params['parent'] = parent unless parent.nil?
1015
+ command.query['fields'] = fields unless fields.nil?
1016
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1017
+ execute_or_queue_command(command, &block)
1018
+ end
1019
+
1020
+ # Deletes a phrase matcher.
1021
+ # @param [String] name
1022
+ # Required. The name of the phrase matcher to delete.
1023
+ # @param [String] fields
1024
+ # Selector specifying which fields to include in a partial response.
1025
+ # @param [String] quota_user
1026
+ # Available to use for quota purposes for server-side applications. Can be any
1027
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1028
+ # @param [Google::Apis::RequestOptions] options
1029
+ # Request-specific options
1030
+ #
1031
+ # @yield [result, err] Result & error if block supplied
1032
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty] parsed result object
1033
+ # @yieldparam err [StandardError] error object if request failed
1034
+ #
1035
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty]
1036
+ #
1037
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1038
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1039
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1040
+ def delete_project_location_phrase_matcher(name, fields: nil, quota_user: nil, options: nil, &block)
1041
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1042
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty::Representation
1043
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleProtobufEmpty
1044
+ command.params['name'] = name unless name.nil?
1045
+ command.query['fields'] = fields unless fields.nil?
1046
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1047
+ execute_or_queue_command(command, &block)
1048
+ end
1049
+
1050
+ # Gets a phrase matcher.
1051
+ # @param [String] name
1052
+ # Required. The name of the phrase matcher to get.
1053
+ # @param [String] fields
1054
+ # Selector specifying which fields to include in a partial response.
1055
+ # @param [String] quota_user
1056
+ # Available to use for quota purposes for server-side applications. Can be any
1057
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1058
+ # @param [Google::Apis::RequestOptions] options
1059
+ # Request-specific options
1060
+ #
1061
+ # @yield [result, err] Result & error if block supplied
1062
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher] parsed result object
1063
+ # @yieldparam err [StandardError] error object if request failed
1064
+ #
1065
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher]
1066
+ #
1067
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1068
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1069
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1070
+ def get_project_location_phrase_matcher(name, fields: nil, quota_user: nil, options: nil, &block)
1071
+ command = make_simple_command(:get, 'v1/{+name}', options)
1072
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher::Representation
1073
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1PhraseMatcher
1074
+ command.params['name'] = name unless name.nil?
1075
+ command.query['fields'] = fields unless fields.nil?
1076
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1077
+ execute_or_queue_command(command, &block)
1078
+ end
1079
+
1080
+ # Lists phrase matchers.
1081
+ # @param [String] parent
1082
+ # Required. The parent resource of the phrase matcher.
1083
+ # @param [String] filter
1084
+ # A filter to reduce results to a specific subset. Useful for querying phrase
1085
+ # matchers with specific properties.
1086
+ # @param [Fixnum] page_size
1087
+ # The maximum number of phrase matchers to return in the response. If this value
1088
+ # is zero, the service will select a default size. A call might return fewer
1089
+ # objects than requested. A non-empty `next_page_token` in the response
1090
+ # indicates that more data is available.
1091
+ # @param [String] page_token
1092
+ # The value returned by the last `ListPhraseMatchersResponse`. This value
1093
+ # indicates that this is a continuation of a prior `ListPhraseMatchers` call and
1094
+ # that the system should return the next page of data.
1095
+ # @param [String] fields
1096
+ # Selector specifying which fields to include in a partial response.
1097
+ # @param [String] quota_user
1098
+ # Available to use for quota purposes for server-side applications. Can be any
1099
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1100
+ # @param [Google::Apis::RequestOptions] options
1101
+ # Request-specific options
1102
+ #
1103
+ # @yield [result, err] Result & error if block supplied
1104
+ # @yieldparam result [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse] parsed result object
1105
+ # @yieldparam err [StandardError] error object if request failed
1106
+ #
1107
+ # @return [Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse]
1108
+ #
1109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1112
+ def list_project_location_phrase_matchers(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1113
+ command = make_simple_command(:get, 'v1/{+parent}/phraseMatchers', options)
1114
+ command.response_representation = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse::Representation
1115
+ command.response_class = Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse
1116
+ command.params['parent'] = parent unless parent.nil?
1117
+ command.query['filter'] = filter unless filter.nil?
1118
+ command.query['pageSize'] = page_size unless page_size.nil?
1119
+ command.query['pageToken'] = page_token unless page_token.nil?
1120
+ command.query['fields'] = fields unless fields.nil?
1121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1122
+ execute_or_queue_command(command, &block)
1123
+ end
1124
+
1125
+ protected
1126
+
1127
+ def apply_command_defaults(command)
1128
+ command.query['key'] = key unless key.nil?
1129
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1130
+ end
1131
+ end
1132
+ end
1133
+ end
1134
+ end