google-apis-contactcenteraiplatform_v1alpha1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,532 @@
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 ContactcenteraiplatformV1alpha1
23
+ # Contact Center AI Platform API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/contactcenteraiplatform_v1alpha1'
29
+ #
30
+ # Contactcenteraiplatform = Google::Apis::ContactcenteraiplatformV1alpha1 # Alias the module
31
+ # service = Contactcenteraiplatform::CCAIPlatformService.new
32
+ #
33
+ # @see https://cloud.google.com/solutions/contact-center-ai-platform
34
+ class CCAIPlatformService < 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://contactcenteraiplatform.googleapis.com/', '',
47
+ client_name: 'google-apis-contactcenteraiplatform_v1alpha1',
48
+ client_version: Google::Apis::ContactcenteraiplatformV1alpha1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Gets information about a location.
53
+ # @param [String] name
54
+ # Resource name for the location.
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::ContactcenteraiplatformV1alpha1::Location] parsed result object
65
+ # @yieldparam err [StandardError] error object if request failed
66
+ #
67
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Location]
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(name, fields: nil, quota_user: nil, options: nil, &block)
73
+ command = make_simple_command(:get, 'v1alpha1/{+name}', options)
74
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Location::Representation
75
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Location
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
+ # Lists information about the supported locations for this service.
83
+ # @param [String] name
84
+ # The resource that owns the locations collection, if applicable.
85
+ # @param [String] filter
86
+ # A filter to narrow down results to a preferred subset. The filtering language
87
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
88
+ # in [AIP-160](https://google.aip.dev/160).
89
+ # @param [Fixnum] page_size
90
+ # The maximum number of results to return. If not set, the service selects a
91
+ # default.
92
+ # @param [String] page_token
93
+ # A page token received from the `next_page_token` field in the response. Send
94
+ # that page token to receive the subsequent page.
95
+ # @param [String] fields
96
+ # Selector specifying which fields to include in a partial response.
97
+ # @param [String] quota_user
98
+ # Available to use for quota purposes for server-side applications. Can be any
99
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
100
+ # @param [Google::Apis::RequestOptions] options
101
+ # Request-specific options
102
+ #
103
+ # @yield [result, err] Result & error if block supplied
104
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::ListLocationsResponse] parsed result object
105
+ # @yieldparam err [StandardError] error object if request failed
106
+ #
107
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ListLocationsResponse]
108
+ #
109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
112
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
113
+ command = make_simple_command(:get, 'v1alpha1/{+name}/locations', options)
114
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ListLocationsResponse::Representation
115
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::ListLocationsResponse
116
+ command.params['name'] = name unless name.nil?
117
+ command.query['filter'] = filter unless filter.nil?
118
+ command.query['pageSize'] = page_size unless page_size.nil?
119
+ command.query['pageToken'] = page_token unless page_token.nil?
120
+ command.query['fields'] = fields unless fields.nil?
121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
122
+ execute_or_queue_command(command, &block)
123
+ end
124
+
125
+ # Queries the contact center quota, an aggregation over all the projects, that
126
+ # belongs to the billing account, which the input project belongs to.
127
+ # @param [String] parent
128
+ # Required. Parent project resource id.
129
+ # @param [String] fields
130
+ # Selector specifying which fields to include in a partial response.
131
+ # @param [String] quota_user
132
+ # Available to use for quota purposes for server-side applications. Can be any
133
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
134
+ # @param [Google::Apis::RequestOptions] options
135
+ # Request-specific options
136
+ #
137
+ # @yield [result, err] Result & error if block supplied
138
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenterQuota] parsed result object
139
+ # @yieldparam err [StandardError] error object if request failed
140
+ #
141
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenterQuota]
142
+ #
143
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
144
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
145
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
146
+ def query_project_location_contact_center_quota(parent, fields: nil, quota_user: nil, options: nil, &block)
147
+ command = make_simple_command(:get, 'v1alpha1/{+parent}:queryContactCenterQuota', options)
148
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenterQuota::Representation
149
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenterQuota
150
+ command.params['parent'] = parent unless parent.nil?
151
+ command.query['fields'] = fields unless fields.nil?
152
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
153
+ execute_or_queue_command(command, &block)
154
+ end
155
+
156
+ # Creates a new ContactCenter in a given project and location.
157
+ # @param [String] parent
158
+ # Required. Value for parent.
159
+ # @param [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter] contact_center_object
160
+ # @param [String] contact_center_id
161
+ # Required. Id of the requesting object If auto-generating Id server-side,
162
+ # remove this field and contact_center_id from the method_signature of Create
163
+ # RPC
164
+ # @param [String] request_id
165
+ # Optional. An optional request ID to identify requests. Specify a unique
166
+ # request ID so that if you must retry your request, the server will know to
167
+ # ignore the request if it has already been completed. The server will guarantee
168
+ # that for at least 60 minutes since the first request. For example, consider a
169
+ # situation where you make an initial request and t he request times out. If you
170
+ # make the request again with the same request ID, the server can check if
171
+ # original operation with the same request ID was received, and if so, will
172
+ # ignore the second request. This prevents clients from accidentally creating
173
+ # duplicate commitments. The request ID must be a valid UUID with the exception
174
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
175
+ # @param [String] fields
176
+ # Selector specifying which fields to include in a partial response.
177
+ # @param [String] quota_user
178
+ # Available to use for quota purposes for server-side applications. Can be any
179
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
180
+ # @param [Google::Apis::RequestOptions] options
181
+ # Request-specific options
182
+ #
183
+ # @yield [result, err] Result & error if block supplied
184
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Operation] parsed result object
185
+ # @yieldparam err [StandardError] error object if request failed
186
+ #
187
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Operation]
188
+ #
189
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
190
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
191
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
192
+ def create_project_location_contact_center(parent, contact_center_object = nil, contact_center_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
193
+ command = make_simple_command(:post, 'v1alpha1/{+parent}/contactCenters', options)
194
+ command.request_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter::Representation
195
+ command.request_object = contact_center_object
196
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Operation::Representation
197
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Operation
198
+ command.params['parent'] = parent unless parent.nil?
199
+ command.query['contactCenterId'] = contact_center_id unless contact_center_id.nil?
200
+ command.query['requestId'] = request_id unless request_id.nil?
201
+ command.query['fields'] = fields unless fields.nil?
202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
203
+ execute_or_queue_command(command, &block)
204
+ end
205
+
206
+ # Deletes a single ContactCenter.
207
+ # @param [String] name
208
+ # Required. Name of the resource
209
+ # @param [String] request_id
210
+ # Optional. An optional request ID to identify requests. Specify a unique
211
+ # request ID so that if you must retry your request, the server will know to
212
+ # ignore the request if it has already been completed. The server will guarantee
213
+ # that for at least 60 minutes after the first request. For example, consider a
214
+ # situation where you make an initial request and t he request times out. If you
215
+ # make the request again with the same request ID, the server can check if
216
+ # original operation with the same request ID was received, and if so, will
217
+ # ignore the second request. This prevents clients from accidentally creating
218
+ # duplicate commitments. The request ID must be a valid UUID with the exception
219
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
220
+ # @param [String] fields
221
+ # Selector specifying which fields to include in a partial response.
222
+ # @param [String] quota_user
223
+ # Available to use for quota purposes for server-side applications. Can be any
224
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
225
+ # @param [Google::Apis::RequestOptions] options
226
+ # Request-specific options
227
+ #
228
+ # @yield [result, err] Result & error if block supplied
229
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Operation] parsed result object
230
+ # @yieldparam err [StandardError] error object if request failed
231
+ #
232
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Operation]
233
+ #
234
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
235
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
236
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
237
+ def delete_project_location_contact_center(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
238
+ command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
239
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Operation::Representation
240
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Operation
241
+ command.params['name'] = name unless name.nil?
242
+ command.query['requestId'] = request_id unless request_id.nil?
243
+ command.query['fields'] = fields unless fields.nil?
244
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
245
+ execute_or_queue_command(command, &block)
246
+ end
247
+
248
+ # Gets details of a single ContactCenter.
249
+ # @param [String] name
250
+ # Required. Name of the resource
251
+ # @param [String] fields
252
+ # Selector specifying which fields to include in a partial response.
253
+ # @param [String] quota_user
254
+ # Available to use for quota purposes for server-side applications. Can be any
255
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
256
+ # @param [Google::Apis::RequestOptions] options
257
+ # Request-specific options
258
+ #
259
+ # @yield [result, err] Result & error if block supplied
260
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter] parsed result object
261
+ # @yieldparam err [StandardError] error object if request failed
262
+ #
263
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter]
264
+ #
265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
268
+ def get_project_location_contact_center(name, fields: nil, quota_user: nil, options: nil, &block)
269
+ command = make_simple_command(:get, 'v1alpha1/{+name}', options)
270
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter::Representation
271
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter
272
+ command.params['name'] = name unless name.nil?
273
+ command.query['fields'] = fields unless fields.nil?
274
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
275
+ execute_or_queue_command(command, &block)
276
+ end
277
+
278
+ # Lists ContactCenters in a given project and location.
279
+ # @param [String] parent
280
+ # Required. Parent value for ListContactCentersRequest
281
+ # @param [String] filter
282
+ # Filtering results
283
+ # @param [String] order_by
284
+ # Hint for how to order the results
285
+ # @param [Fixnum] page_size
286
+ # Requested page size. Server may return fewer items than requested. If
287
+ # unspecified, server will pick an appropriate default.
288
+ # @param [String] page_token
289
+ # A token identifying a page of results the server should return.
290
+ # @param [String] fields
291
+ # Selector specifying which fields to include in a partial response.
292
+ # @param [String] quota_user
293
+ # Available to use for quota purposes for server-side applications. Can be any
294
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
295
+ # @param [Google::Apis::RequestOptions] options
296
+ # Request-specific options
297
+ #
298
+ # @yield [result, err] Result & error if block supplied
299
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::ListContactCentersResponse] parsed result object
300
+ # @yieldparam err [StandardError] error object if request failed
301
+ #
302
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ListContactCentersResponse]
303
+ #
304
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
305
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
306
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
307
+ def list_project_location_contact_centers(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
308
+ command = make_simple_command(:get, 'v1alpha1/{+parent}/contactCenters', options)
309
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ListContactCentersResponse::Representation
310
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::ListContactCentersResponse
311
+ command.params['parent'] = parent unless parent.nil?
312
+ command.query['filter'] = filter unless filter.nil?
313
+ command.query['orderBy'] = order_by unless order_by.nil?
314
+ command.query['pageSize'] = page_size unless page_size.nil?
315
+ command.query['pageToken'] = page_token unless page_token.nil?
316
+ command.query['fields'] = fields unless fields.nil?
317
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
318
+ execute_or_queue_command(command, &block)
319
+ end
320
+
321
+ # Updates the parameters of a single ContactCenter.
322
+ # @param [String] name
323
+ # name of resource
324
+ # @param [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter] contact_center_object
325
+ # @param [String] request_id
326
+ # Optional. An optional request ID to identify requests. Specify a unique
327
+ # request ID so that if you must retry your request, the server will know to
328
+ # ignore the request if it has already been completed. The server will guarantee
329
+ # that for at least 60 minutes since the first request. For example, consider a
330
+ # situation where you make an initial request and t he request times out. If you
331
+ # make the request again with the same request ID, the server can check if
332
+ # original operation with the same request ID was received, and if so, will
333
+ # ignore the second request. This prevents clients from accidentally creating
334
+ # duplicate commitments. The request ID must be a valid UUID with the exception
335
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
336
+ # @param [String] update_mask
337
+ # Required. Field mask is used to specify the fields to be overwritten in the
338
+ # ContactCenter resource by the update. The fields specified in the update_mask
339
+ # are relative to the resource, not the full request. A field will be
340
+ # overwritten if it is in the mask. If the user does not provide a mask then all
341
+ # fields will be overwritten.
342
+ # @param [String] fields
343
+ # Selector specifying which fields to include in a partial response.
344
+ # @param [String] quota_user
345
+ # Available to use for quota purposes for server-side applications. Can be any
346
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
347
+ # @param [Google::Apis::RequestOptions] options
348
+ # Request-specific options
349
+ #
350
+ # @yield [result, err] Result & error if block supplied
351
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Operation] parsed result object
352
+ # @yieldparam err [StandardError] error object if request failed
353
+ #
354
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Operation]
355
+ #
356
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
357
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
358
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
359
+ def patch_project_location_contact_center(name, contact_center_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
360
+ command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
361
+ command.request_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter::Representation
362
+ command.request_object = contact_center_object
363
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Operation::Representation
364
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Operation
365
+ command.params['name'] = name unless name.nil?
366
+ command.query['requestId'] = request_id unless request_id.nil?
367
+ command.query['updateMask'] = update_mask unless update_mask.nil?
368
+ command.query['fields'] = fields unless fields.nil?
369
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
370
+ execute_or_queue_command(command, &block)
371
+ end
372
+
373
+ # Starts asynchronous cancellation on a long-running operation. The server makes
374
+ # a best effort to cancel the operation, but success is not guaranteed. If the
375
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
376
+ # Clients can use Operations.GetOperation or other methods to check whether the
377
+ # cancellation succeeded or whether the operation completed despite cancellation.
378
+ # On successful cancellation, the operation is not deleted; instead, it becomes
379
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
380
+ # corresponding to `Code.CANCELLED`.
381
+ # @param [String] name
382
+ # The name of the operation resource to be cancelled.
383
+ # @param [Google::Apis::ContactcenteraiplatformV1alpha1::CancelOperationRequest] cancel_operation_request_object
384
+ # @param [String] fields
385
+ # Selector specifying which fields to include in a partial response.
386
+ # @param [String] quota_user
387
+ # Available to use for quota purposes for server-side applications. Can be any
388
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
389
+ # @param [Google::Apis::RequestOptions] options
390
+ # Request-specific options
391
+ #
392
+ # @yield [result, err] Result & error if block supplied
393
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Empty] parsed result object
394
+ # @yieldparam err [StandardError] error object if request failed
395
+ #
396
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Empty]
397
+ #
398
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
399
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
400
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
401
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
402
+ command = make_simple_command(:post, 'v1alpha1/{+name}:cancel', options)
403
+ command.request_representation = Google::Apis::ContactcenteraiplatformV1alpha1::CancelOperationRequest::Representation
404
+ command.request_object = cancel_operation_request_object
405
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Empty::Representation
406
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Empty
407
+ command.params['name'] = name unless name.nil?
408
+ command.query['fields'] = fields unless fields.nil?
409
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
410
+ execute_or_queue_command(command, &block)
411
+ end
412
+
413
+ # Deletes a long-running operation. This method indicates that the client is no
414
+ # longer interested in the operation result. It does not cancel the operation.
415
+ # If the server doesn't support this method, it returns `google.rpc.Code.
416
+ # UNIMPLEMENTED`.
417
+ # @param [String] name
418
+ # The name of the operation resource to be deleted.
419
+ # @param [String] fields
420
+ # Selector specifying which fields to include in a partial response.
421
+ # @param [String] quota_user
422
+ # Available to use for quota purposes for server-side applications. Can be any
423
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
424
+ # @param [Google::Apis::RequestOptions] options
425
+ # Request-specific options
426
+ #
427
+ # @yield [result, err] Result & error if block supplied
428
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Empty] parsed result object
429
+ # @yieldparam err [StandardError] error object if request failed
430
+ #
431
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Empty]
432
+ #
433
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
434
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
435
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
436
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
437
+ command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
438
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Empty::Representation
439
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Empty
440
+ command.params['name'] = name unless name.nil?
441
+ command.query['fields'] = fields unless fields.nil?
442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
443
+ execute_or_queue_command(command, &block)
444
+ end
445
+
446
+ # Gets the latest state of a long-running operation. Clients can use this method
447
+ # to poll the operation result at intervals as recommended by the API service.
448
+ # @param [String] name
449
+ # The name of the operation resource.
450
+ # @param [String] fields
451
+ # Selector specifying which fields to include in a partial response.
452
+ # @param [String] quota_user
453
+ # Available to use for quota purposes for server-side applications. Can be any
454
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
455
+ # @param [Google::Apis::RequestOptions] options
456
+ # Request-specific options
457
+ #
458
+ # @yield [result, err] Result & error if block supplied
459
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::Operation] parsed result object
460
+ # @yieldparam err [StandardError] error object if request failed
461
+ #
462
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Operation]
463
+ #
464
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
465
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
466
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
467
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
468
+ command = make_simple_command(:get, 'v1alpha1/{+name}', options)
469
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::Operation::Representation
470
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::Operation
471
+ command.params['name'] = name unless name.nil?
472
+ command.query['fields'] = fields unless fields.nil?
473
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
474
+ execute_or_queue_command(command, &block)
475
+ end
476
+
477
+ # Lists operations that match the specified filter in the request. If the server
478
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
479
+ # binding allows API services to override the binding to use different resource
480
+ # name schemes, such as `users/*/operations`. To override the binding, API
481
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
482
+ # service configuration. For backwards compatibility, the default name includes
483
+ # the operations collection id, however overriding users must ensure the name
484
+ # binding is the parent resource, without the operations collection id.
485
+ # @param [String] name
486
+ # The name of the operation's parent resource.
487
+ # @param [String] filter
488
+ # The standard list filter.
489
+ # @param [Fixnum] page_size
490
+ # The standard list page size.
491
+ # @param [String] page_token
492
+ # The standard list page token.
493
+ # @param [String] fields
494
+ # Selector specifying which fields to include in a partial response.
495
+ # @param [String] quota_user
496
+ # Available to use for quota purposes for server-side applications. Can be any
497
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
498
+ # @param [Google::Apis::RequestOptions] options
499
+ # Request-specific options
500
+ #
501
+ # @yield [result, err] Result & error if block supplied
502
+ # @yieldparam result [Google::Apis::ContactcenteraiplatformV1alpha1::ListOperationsResponse] parsed result object
503
+ # @yieldparam err [StandardError] error object if request failed
504
+ #
505
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ListOperationsResponse]
506
+ #
507
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
508
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
509
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
510
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
511
+ command = make_simple_command(:get, 'v1alpha1/{+name}/operations', options)
512
+ command.response_representation = Google::Apis::ContactcenteraiplatformV1alpha1::ListOperationsResponse::Representation
513
+ command.response_class = Google::Apis::ContactcenteraiplatformV1alpha1::ListOperationsResponse
514
+ command.params['name'] = name unless name.nil?
515
+ command.query['filter'] = filter unless filter.nil?
516
+ command.query['pageSize'] = page_size unless page_size.nil?
517
+ command.query['pageToken'] = page_token unless page_token.nil?
518
+ command.query['fields'] = fields unless fields.nil?
519
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
520
+ execute_or_queue_command(command, &block)
521
+ end
522
+
523
+ protected
524
+
525
+ def apply_command_defaults(command)
526
+ command.query['key'] = key unless key.nil?
527
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
528
+ end
529
+ end
530
+ end
531
+ end
532
+ end
@@ -0,0 +1,36 @@
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/contactcenteraiplatform_v1alpha1/service.rb'
16
+ require 'google/apis/contactcenteraiplatform_v1alpha1/classes.rb'
17
+ require 'google/apis/contactcenteraiplatform_v1alpha1/representations.rb'
18
+ require 'google/apis/contactcenteraiplatform_v1alpha1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Contact Center AI Platform API
23
+ #
24
+ #
25
+ #
26
+ # @see https://cloud.google.com/solutions/contact-center-ai-platform
27
+ module ContactcenteraiplatformV1alpha1
28
+ # Version of the Contact Center AI Platform API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1alpha1'
31
+
32
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
33
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,15 @@
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/contactcenteraiplatform_v1alpha1"