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,555 @@
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 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module ContactcenteraiplatformV1alpha1
24
+
25
+ # The request message for Operations.CancelOperation.
26
+ class CancelOperationRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ def initialize(**args)
30
+ update!(**args)
31
+ end
32
+
33
+ # Update properties of this object
34
+ def update!(**args)
35
+ end
36
+ end
37
+
38
+ # Message describing ContactCenter object
39
+ class ContactCenter
40
+ include Google::Apis::Core::Hashable
41
+
42
+ # Optional. Whether to enable users to be created in the CCAIP-instance
43
+ # concurrently to having users in Cloud identity
44
+ # Corresponds to the JSON property `ccaipManagedUsers`
45
+ # @return [Boolean]
46
+ attr_accessor :ccaip_managed_users
47
+ alias_method :ccaip_managed_users?, :ccaip_managed_users
48
+
49
+ # Output only. [Output only] Create time stamp
50
+ # Corresponds to the JSON property `createTime`
51
+ # @return [String]
52
+ attr_accessor :create_time
53
+
54
+ # Required. Immutable. At least 2 and max 16 char long, must conform to [RFC
55
+ # 1035](https://www.ietf.org/rfc/rfc1035.txt).
56
+ # Corresponds to the JSON property `customerDomainPrefix`
57
+ # @return [String]
58
+ attr_accessor :customer_domain_prefix
59
+
60
+ # Required. A user friendly name for the ContactCenter.
61
+ # Corresponds to the JSON property `displayName`
62
+ # @return [String]
63
+ attr_accessor :display_name
64
+
65
+ # Message storing the instance configuration.
66
+ # Corresponds to the JSON property `instanceConfig`
67
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::InstanceConfig]
68
+ attr_accessor :instance_config
69
+
70
+ # Labels as key value pairs
71
+ # Corresponds to the JSON property `labels`
72
+ # @return [Hash<String,String>]
73
+ attr_accessor :labels
74
+
75
+ # name of resource
76
+ # Corresponds to the JSON property `name`
77
+ # @return [String]
78
+ attr_accessor :name
79
+
80
+ # Message storing SAML params to enable Google as IDP.
81
+ # Corresponds to the JSON property `samlParams`
82
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::SamlParams]
83
+ attr_accessor :saml_params
84
+
85
+ # Output only. The state of this contact center.
86
+ # Corresponds to the JSON property `state`
87
+ # @return [String]
88
+ attr_accessor :state
89
+
90
+ # Output only. [Output only] Update time stamp
91
+ # Corresponds to the JSON property `updateTime`
92
+ # @return [String]
93
+ attr_accessor :update_time
94
+
95
+ # Message storing the URIs of the ContactCenter.
96
+ # Corresponds to the JSON property `uris`
97
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::UrIs]
98
+ attr_accessor :uris
99
+
100
+ # Optional. Email address of the first admin users.
101
+ # Corresponds to the JSON property `userEmail`
102
+ # @return [String]
103
+ attr_accessor :user_email
104
+
105
+ def initialize(**args)
106
+ update!(**args)
107
+ end
108
+
109
+ # Update properties of this object
110
+ def update!(**args)
111
+ @ccaip_managed_users = args[:ccaip_managed_users] if args.key?(:ccaip_managed_users)
112
+ @create_time = args[:create_time] if args.key?(:create_time)
113
+ @customer_domain_prefix = args[:customer_domain_prefix] if args.key?(:customer_domain_prefix)
114
+ @display_name = args[:display_name] if args.key?(:display_name)
115
+ @instance_config = args[:instance_config] if args.key?(:instance_config)
116
+ @labels = args[:labels] if args.key?(:labels)
117
+ @name = args[:name] if args.key?(:name)
118
+ @saml_params = args[:saml_params] if args.key?(:saml_params)
119
+ @state = args[:state] if args.key?(:state)
120
+ @update_time = args[:update_time] if args.key?(:update_time)
121
+ @uris = args[:uris] if args.key?(:uris)
122
+ @user_email = args[:user_email] if args.key?(:user_email)
123
+ end
124
+ end
125
+
126
+ # Represents a quota for contact centers.
127
+ class ContactCenterQuota
128
+ include Google::Apis::Core::Hashable
129
+
130
+ # Reflects the count limit of contact centers on a billing account.
131
+ # Corresponds to the JSON property `contactCenterCountLimit`
132
+ # @return [Fixnum]
133
+ attr_accessor :contact_center_count_limit
134
+
135
+ # Reflects the count sum of contact centers on a billing account.
136
+ # Corresponds to the JSON property `contactCenterCountSum`
137
+ # @return [Fixnum]
138
+ attr_accessor :contact_center_count_sum
139
+
140
+ def initialize(**args)
141
+ update!(**args)
142
+ end
143
+
144
+ # Update properties of this object
145
+ def update!(**args)
146
+ @contact_center_count_limit = args[:contact_center_count_limit] if args.key?(:contact_center_count_limit)
147
+ @contact_center_count_sum = args[:contact_center_count_sum] if args.key?(:contact_center_count_sum)
148
+ end
149
+ end
150
+
151
+ # A generic empty message that you can re-use to avoid defining duplicated empty
152
+ # messages in your APIs. A typical example is to use it as the request or the
153
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
154
+ # protobuf.Empty) returns (google.protobuf.Empty); `
155
+ class Empty
156
+ include Google::Apis::Core::Hashable
157
+
158
+ def initialize(**args)
159
+ update!(**args)
160
+ end
161
+
162
+ # Update properties of this object
163
+ def update!(**args)
164
+ end
165
+ end
166
+
167
+ # Message storing the instance configuration.
168
+ class InstanceConfig
169
+ include Google::Apis::Core::Hashable
170
+
171
+ # The instance size of this the instance configuration.
172
+ # Corresponds to the JSON property `instanceSize`
173
+ # @return [String]
174
+ attr_accessor :instance_size
175
+
176
+ def initialize(**args)
177
+ update!(**args)
178
+ end
179
+
180
+ # Update properties of this object
181
+ def update!(**args)
182
+ @instance_size = args[:instance_size] if args.key?(:instance_size)
183
+ end
184
+ end
185
+
186
+ # Message for response to listing ContactCenters
187
+ class ListContactCentersResponse
188
+ include Google::Apis::Core::Hashable
189
+
190
+ # The list of ContactCenter
191
+ # Corresponds to the JSON property `contactCenters`
192
+ # @return [Array<Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter>]
193
+ attr_accessor :contact_centers
194
+
195
+ # A token identifying a page of results the server should return.
196
+ # Corresponds to the JSON property `nextPageToken`
197
+ # @return [String]
198
+ attr_accessor :next_page_token
199
+
200
+ # Locations that could not be reached.
201
+ # Corresponds to the JSON property `unreachable`
202
+ # @return [Array<String>]
203
+ attr_accessor :unreachable
204
+
205
+ def initialize(**args)
206
+ update!(**args)
207
+ end
208
+
209
+ # Update properties of this object
210
+ def update!(**args)
211
+ @contact_centers = args[:contact_centers] if args.key?(:contact_centers)
212
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
213
+ @unreachable = args[:unreachable] if args.key?(:unreachable)
214
+ end
215
+ end
216
+
217
+ # The response message for Locations.ListLocations.
218
+ class ListLocationsResponse
219
+ include Google::Apis::Core::Hashable
220
+
221
+ # A list of locations that matches the specified filter in the request.
222
+ # Corresponds to the JSON property `locations`
223
+ # @return [Array<Google::Apis::ContactcenteraiplatformV1alpha1::Location>]
224
+ attr_accessor :locations
225
+
226
+ # The standard List next-page token.
227
+ # Corresponds to the JSON property `nextPageToken`
228
+ # @return [String]
229
+ attr_accessor :next_page_token
230
+
231
+ def initialize(**args)
232
+ update!(**args)
233
+ end
234
+
235
+ # Update properties of this object
236
+ def update!(**args)
237
+ @locations = args[:locations] if args.key?(:locations)
238
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
239
+ end
240
+ end
241
+
242
+ # The response message for Operations.ListOperations.
243
+ class ListOperationsResponse
244
+ include Google::Apis::Core::Hashable
245
+
246
+ # The standard List next-page token.
247
+ # Corresponds to the JSON property `nextPageToken`
248
+ # @return [String]
249
+ attr_accessor :next_page_token
250
+
251
+ # A list of operations that matches the specified filter in the request.
252
+ # Corresponds to the JSON property `operations`
253
+ # @return [Array<Google::Apis::ContactcenteraiplatformV1alpha1::Operation>]
254
+ attr_accessor :operations
255
+
256
+ def initialize(**args)
257
+ update!(**args)
258
+ end
259
+
260
+ # Update properties of this object
261
+ def update!(**args)
262
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
263
+ @operations = args[:operations] if args.key?(:operations)
264
+ end
265
+ end
266
+
267
+ # A resource that represents Google Cloud Platform location.
268
+ class Location
269
+ include Google::Apis::Core::Hashable
270
+
271
+ # The friendly name for this location, typically a nearby city name. For example,
272
+ # "Tokyo".
273
+ # Corresponds to the JSON property `displayName`
274
+ # @return [String]
275
+ attr_accessor :display_name
276
+
277
+ # Cross-service attributes for the location. For example `"cloud.googleapis.com/
278
+ # region": "us-east1"`
279
+ # Corresponds to the JSON property `labels`
280
+ # @return [Hash<String,String>]
281
+ attr_accessor :labels
282
+
283
+ # The canonical id for this location. For example: `"us-east1"`.
284
+ # Corresponds to the JSON property `locationId`
285
+ # @return [String]
286
+ attr_accessor :location_id
287
+
288
+ # Service-specific metadata. For example the available capacity at the given
289
+ # location.
290
+ # Corresponds to the JSON property `metadata`
291
+ # @return [Hash<String,Object>]
292
+ attr_accessor :metadata
293
+
294
+ # Resource name for the location, which may vary between implementations. For
295
+ # example: `"projects/example-project/locations/us-east1"`
296
+ # Corresponds to the JSON property `name`
297
+ # @return [String]
298
+ attr_accessor :name
299
+
300
+ def initialize(**args)
301
+ update!(**args)
302
+ end
303
+
304
+ # Update properties of this object
305
+ def update!(**args)
306
+ @display_name = args[:display_name] if args.key?(:display_name)
307
+ @labels = args[:labels] if args.key?(:labels)
308
+ @location_id = args[:location_id] if args.key?(:location_id)
309
+ @metadata = args[:metadata] if args.key?(:metadata)
310
+ @name = args[:name] if args.key?(:name)
311
+ end
312
+ end
313
+
314
+ # This resource represents a long-running operation that is the result of a
315
+ # network API call.
316
+ class Operation
317
+ include Google::Apis::Core::Hashable
318
+
319
+ # If the value is `false`, it means the operation is still in progress. If `true`
320
+ # , the operation is completed, and either `error` or `response` is available.
321
+ # Corresponds to the JSON property `done`
322
+ # @return [Boolean]
323
+ attr_accessor :done
324
+ alias_method :done?, :done
325
+
326
+ # The `Status` type defines a logical error model that is suitable for different
327
+ # programming environments, including REST APIs and RPC APIs. It is used by [
328
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
329
+ # data: error code, error message, and error details. You can find out more
330
+ # about this error model and how to work with it in the [API Design Guide](https:
331
+ # //cloud.google.com/apis/design/errors).
332
+ # Corresponds to the JSON property `error`
333
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::Status]
334
+ attr_accessor :error
335
+
336
+ # Service-specific metadata associated with the operation. It typically contains
337
+ # progress information and common metadata such as create time. Some services
338
+ # might not provide such metadata. Any method that returns a long-running
339
+ # operation should document the metadata type, if any.
340
+ # Corresponds to the JSON property `metadata`
341
+ # @return [Hash<String,Object>]
342
+ attr_accessor :metadata
343
+
344
+ # The server-assigned name, which is only unique within the same service that
345
+ # originally returns it. If you use the default HTTP mapping, the `name` should
346
+ # be a resource name ending with `operations/`unique_id``.
347
+ # Corresponds to the JSON property `name`
348
+ # @return [String]
349
+ attr_accessor :name
350
+
351
+ # The normal response of the operation in case of success. If the original
352
+ # method returns no data on success, such as `Delete`, the response is `google.
353
+ # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
354
+ # the response should be the resource. For other methods, the response should
355
+ # have the type `XxxResponse`, where `Xxx` is the original method name. For
356
+ # example, if the original method name is `TakeSnapshot()`, the inferred
357
+ # response type is `TakeSnapshotResponse`.
358
+ # Corresponds to the JSON property `response`
359
+ # @return [Hash<String,Object>]
360
+ attr_accessor :response
361
+
362
+ def initialize(**args)
363
+ update!(**args)
364
+ end
365
+
366
+ # Update properties of this object
367
+ def update!(**args)
368
+ @done = args[:done] if args.key?(:done)
369
+ @error = args[:error] if args.key?(:error)
370
+ @metadata = args[:metadata] if args.key?(:metadata)
371
+ @name = args[:name] if args.key?(:name)
372
+ @response = args[:response] if args.key?(:response)
373
+ end
374
+ end
375
+
376
+ # Represents the metadata of the long-running operation.
377
+ class OperationMetadata
378
+ include Google::Apis::Core::Hashable
379
+
380
+ # Output only. API version used to start the operation.
381
+ # Corresponds to the JSON property `apiVersion`
382
+ # @return [String]
383
+ attr_accessor :api_version
384
+
385
+ # Message describing ContactCenter object
386
+ # Corresponds to the JSON property `contactCenter`
387
+ # @return [Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter]
388
+ attr_accessor :contact_center
389
+
390
+ # Output only. The time the operation was created.
391
+ # Corresponds to the JSON property `createTime`
392
+ # @return [String]
393
+ attr_accessor :create_time
394
+
395
+ # Output only. The time the operation finished running.
396
+ # Corresponds to the JSON property `endTime`
397
+ # @return [String]
398
+ attr_accessor :end_time
399
+
400
+ # Output only. Identifies whether the user has requested cancellation of the
401
+ # operation. Operations that have been cancelled successfully have Operation.
402
+ # error value with a google.rpc.Status.code of 1, corresponding to `Code.
403
+ # CANCELLED`.
404
+ # Corresponds to the JSON property `requestedCancellation`
405
+ # @return [Boolean]
406
+ attr_accessor :requested_cancellation
407
+ alias_method :requested_cancellation?, :requested_cancellation
408
+
409
+ # Output only. Human-readable status of the operation, if any.
410
+ # Corresponds to the JSON property `statusMessage`
411
+ # @return [String]
412
+ attr_accessor :status_message
413
+
414
+ # Output only. Server-defined resource path for the target of the operation.
415
+ # Corresponds to the JSON property `target`
416
+ # @return [String]
417
+ attr_accessor :target
418
+
419
+ # Output only. Name of the verb executed by the operation.
420
+ # Corresponds to the JSON property `verb`
421
+ # @return [String]
422
+ attr_accessor :verb
423
+
424
+ def initialize(**args)
425
+ update!(**args)
426
+ end
427
+
428
+ # Update properties of this object
429
+ def update!(**args)
430
+ @api_version = args[:api_version] if args.key?(:api_version)
431
+ @contact_center = args[:contact_center] if args.key?(:contact_center)
432
+ @create_time = args[:create_time] if args.key?(:create_time)
433
+ @end_time = args[:end_time] if args.key?(:end_time)
434
+ @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation)
435
+ @status_message = args[:status_message] if args.key?(:status_message)
436
+ @target = args[:target] if args.key?(:target)
437
+ @verb = args[:verb] if args.key?(:verb)
438
+ end
439
+ end
440
+
441
+ # Message storing SAML params to enable Google as IDP.
442
+ class SamlParams
443
+ include Google::Apis::Core::Hashable
444
+
445
+ # SAML certificate
446
+ # Corresponds to the JSON property `certificate`
447
+ # @return [String]
448
+ attr_accessor :certificate
449
+
450
+ # Entity id URL
451
+ # Corresponds to the JSON property `entityId`
452
+ # @return [String]
453
+ attr_accessor :entity_id
454
+
455
+ # Single sign-on URL
456
+ # Corresponds to the JSON property `ssoUri`
457
+ # @return [String]
458
+ attr_accessor :sso_uri
459
+
460
+ # Email address of the first admin users.
461
+ # Corresponds to the JSON property `userEmail`
462
+ # @return [String]
463
+ attr_accessor :user_email
464
+
465
+ def initialize(**args)
466
+ update!(**args)
467
+ end
468
+
469
+ # Update properties of this object
470
+ def update!(**args)
471
+ @certificate = args[:certificate] if args.key?(:certificate)
472
+ @entity_id = args[:entity_id] if args.key?(:entity_id)
473
+ @sso_uri = args[:sso_uri] if args.key?(:sso_uri)
474
+ @user_email = args[:user_email] if args.key?(:user_email)
475
+ end
476
+ end
477
+
478
+ # The `Status` type defines a logical error model that is suitable for different
479
+ # programming environments, including REST APIs and RPC APIs. It is used by [
480
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
481
+ # data: error code, error message, and error details. You can find out more
482
+ # about this error model and how to work with it in the [API Design Guide](https:
483
+ # //cloud.google.com/apis/design/errors).
484
+ class Status
485
+ include Google::Apis::Core::Hashable
486
+
487
+ # The status code, which should be an enum value of google.rpc.Code.
488
+ # Corresponds to the JSON property `code`
489
+ # @return [Fixnum]
490
+ attr_accessor :code
491
+
492
+ # A list of messages that carry the error details. There is a common set of
493
+ # message types for APIs to use.
494
+ # Corresponds to the JSON property `details`
495
+ # @return [Array<Hash<String,Object>>]
496
+ attr_accessor :details
497
+
498
+ # A developer-facing error message, which should be in English. Any user-facing
499
+ # error message should be localized and sent in the google.rpc.Status.details
500
+ # field, or localized by the client.
501
+ # Corresponds to the JSON property `message`
502
+ # @return [String]
503
+ attr_accessor :message
504
+
505
+ def initialize(**args)
506
+ update!(**args)
507
+ end
508
+
509
+ # Update properties of this object
510
+ def update!(**args)
511
+ @code = args[:code] if args.key?(:code)
512
+ @details = args[:details] if args.key?(:details)
513
+ @message = args[:message] if args.key?(:message)
514
+ end
515
+ end
516
+
517
+ # Message storing the URIs of the ContactCenter.
518
+ class UrIs
519
+ include Google::Apis::Core::Hashable
520
+
521
+ # Chat Bot Uri of the ContactCenter
522
+ # Corresponds to the JSON property `chatBotUri`
523
+ # @return [String]
524
+ attr_accessor :chat_bot_uri
525
+
526
+ # Media Uri of the ContactCenter.
527
+ # Corresponds to the JSON property `mediaUri`
528
+ # @return [String]
529
+ attr_accessor :media_uri
530
+
531
+ # Root Uri of the ContactCenter.
532
+ # Corresponds to the JSON property `rootUri`
533
+ # @return [String]
534
+ attr_accessor :root_uri
535
+
536
+ # Virtual Agent Streaming Service Uri of the ContactCenter.
537
+ # Corresponds to the JSON property `virtualAgentStreamingServiceUri`
538
+ # @return [String]
539
+ attr_accessor :virtual_agent_streaming_service_uri
540
+
541
+ def initialize(**args)
542
+ update!(**args)
543
+ end
544
+
545
+ # Update properties of this object
546
+ def update!(**args)
547
+ @chat_bot_uri = args[:chat_bot_uri] if args.key?(:chat_bot_uri)
548
+ @media_uri = args[:media_uri] if args.key?(:media_uri)
549
+ @root_uri = args[:root_uri] if args.key?(:root_uri)
550
+ @virtual_agent_streaming_service_uri = args[:virtual_agent_streaming_service_uri] if args.key?(:virtual_agent_streaming_service_uri)
551
+ end
552
+ end
553
+ end
554
+ end
555
+ end
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module ContactcenteraiplatformV1alpha1
18
+ # Version of the google-apis-contactcenteraiplatform_v1alpha1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.11.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20230105"
26
+ end
27
+ end
28
+ end