aws-sdk-connectcases 1.19.0 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectcases/client.rb +1 -1
- data/lib/aws-sdk-connectcases/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-connectcases.rb +1 -1
- data/sig/client.rbs +715 -0
- data/sig/errors.rbs +40 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +823 -0
- data/sig/waiters.rbs +13 -0
- metadata +9 -4
data/sig/client.rbs
ADDED
@@ -0,0 +1,715 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ConnectCases
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?stub_responses: untyped,
|
52
|
+
?token_provider: untyped,
|
53
|
+
?use_dualstack_endpoint: bool,
|
54
|
+
?use_fips_endpoint: bool,
|
55
|
+
?validate_params: bool,
|
56
|
+
?endpoint_provider: untyped,
|
57
|
+
?http_proxy: String,
|
58
|
+
?http_open_timeout: (Float | Integer),
|
59
|
+
?http_read_timeout: (Float | Integer),
|
60
|
+
?http_idle_timeout: (Float | Integer),
|
61
|
+
?http_continue_timeout: (Float | Integer),
|
62
|
+
?ssl_timeout: (Float | Integer | nil),
|
63
|
+
?http_wire_trace: bool,
|
64
|
+
?ssl_verify_peer: bool,
|
65
|
+
?ssl_ca_bundle: String,
|
66
|
+
?ssl_ca_directory: String,
|
67
|
+
?ssl_ca_store: String,
|
68
|
+
?on_chunk_received: Proc,
|
69
|
+
?on_chunk_sent: Proc,
|
70
|
+
?raise_response_errors: bool
|
71
|
+
) -> instance
|
72
|
+
| (?Hash[Symbol, untyped]) -> instance
|
73
|
+
|
74
|
+
|
75
|
+
interface _BatchGetFieldResponseSuccess
|
76
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetFieldResponse]
|
77
|
+
def errors: () -> ::Array[Types::FieldError]
|
78
|
+
def fields: () -> ::Array[Types::GetFieldResponse]
|
79
|
+
end
|
80
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#batch_get_field-instance_method
|
81
|
+
def batch_get_field: (
|
82
|
+
domain_id: ::String,
|
83
|
+
fields: Array[
|
84
|
+
{
|
85
|
+
id: ::String
|
86
|
+
},
|
87
|
+
]
|
88
|
+
) -> _BatchGetFieldResponseSuccess
|
89
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetFieldResponseSuccess
|
90
|
+
|
91
|
+
interface _BatchPutFieldOptionsResponseSuccess
|
92
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchPutFieldOptionsResponse]
|
93
|
+
def errors: () -> ::Array[Types::FieldOptionError]
|
94
|
+
end
|
95
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#batch_put_field_options-instance_method
|
96
|
+
def batch_put_field_options: (
|
97
|
+
domain_id: ::String,
|
98
|
+
field_id: ::String,
|
99
|
+
options: Array[
|
100
|
+
{
|
101
|
+
active: bool,
|
102
|
+
name: ::String,
|
103
|
+
value: ::String
|
104
|
+
},
|
105
|
+
]
|
106
|
+
) -> _BatchPutFieldOptionsResponseSuccess
|
107
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutFieldOptionsResponseSuccess
|
108
|
+
|
109
|
+
interface _CreateCaseResponseSuccess
|
110
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCaseResponse]
|
111
|
+
def case_arn: () -> ::String
|
112
|
+
def case_id: () -> ::String
|
113
|
+
end
|
114
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_case-instance_method
|
115
|
+
def create_case: (
|
116
|
+
?client_token: ::String,
|
117
|
+
domain_id: ::String,
|
118
|
+
fields: Array[
|
119
|
+
{
|
120
|
+
id: ::String,
|
121
|
+
value: {
|
122
|
+
boolean_value: bool?,
|
123
|
+
double_value: ::Float?,
|
124
|
+
empty_value: {
|
125
|
+
}?,
|
126
|
+
string_value: ::String?,
|
127
|
+
user_arn_value: ::String?
|
128
|
+
}
|
129
|
+
},
|
130
|
+
],
|
131
|
+
?performed_by: {
|
132
|
+
user_arn: ::String?
|
133
|
+
},
|
134
|
+
template_id: ::String
|
135
|
+
) -> _CreateCaseResponseSuccess
|
136
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCaseResponseSuccess
|
137
|
+
|
138
|
+
interface _CreateDomainResponseSuccess
|
139
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateDomainResponse]
|
140
|
+
def domain_arn: () -> ::String
|
141
|
+
def domain_id: () -> ::String
|
142
|
+
def domain_status: () -> ("Active" | "CreationInProgress" | "CreationFailed")
|
143
|
+
end
|
144
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_domain-instance_method
|
145
|
+
def create_domain: (
|
146
|
+
name: ::String
|
147
|
+
) -> _CreateDomainResponseSuccess
|
148
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDomainResponseSuccess
|
149
|
+
|
150
|
+
interface _CreateFieldResponseSuccess
|
151
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateFieldResponse]
|
152
|
+
def field_arn: () -> ::String
|
153
|
+
def field_id: () -> ::String
|
154
|
+
end
|
155
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_field-instance_method
|
156
|
+
def create_field: (
|
157
|
+
?description: ::String,
|
158
|
+
domain_id: ::String,
|
159
|
+
name: ::String,
|
160
|
+
type: ("Text" | "Number" | "Boolean" | "DateTime" | "SingleSelect" | "Url" | "User")
|
161
|
+
) -> _CreateFieldResponseSuccess
|
162
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFieldResponseSuccess
|
163
|
+
|
164
|
+
interface _CreateLayoutResponseSuccess
|
165
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateLayoutResponse]
|
166
|
+
def layout_arn: () -> ::String
|
167
|
+
def layout_id: () -> ::String
|
168
|
+
end
|
169
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_layout-instance_method
|
170
|
+
def create_layout: (
|
171
|
+
content: {
|
172
|
+
basic: {
|
173
|
+
more_info: {
|
174
|
+
sections: Array[
|
175
|
+
{
|
176
|
+
field_group: {
|
177
|
+
fields: Array[
|
178
|
+
{
|
179
|
+
id: ::String
|
180
|
+
},
|
181
|
+
],
|
182
|
+
name: ::String?
|
183
|
+
}?
|
184
|
+
},
|
185
|
+
]?
|
186
|
+
}?,
|
187
|
+
top_panel: {
|
188
|
+
sections: Array[
|
189
|
+
{
|
190
|
+
field_group: {
|
191
|
+
fields: Array[
|
192
|
+
{
|
193
|
+
id: ::String
|
194
|
+
},
|
195
|
+
],
|
196
|
+
name: ::String?
|
197
|
+
}?
|
198
|
+
},
|
199
|
+
]?
|
200
|
+
}?
|
201
|
+
}?
|
202
|
+
},
|
203
|
+
domain_id: ::String,
|
204
|
+
name: ::String
|
205
|
+
) -> _CreateLayoutResponseSuccess
|
206
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateLayoutResponseSuccess
|
207
|
+
|
208
|
+
interface _CreateRelatedItemResponseSuccess
|
209
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRelatedItemResponse]
|
210
|
+
def related_item_arn: () -> ::String
|
211
|
+
def related_item_id: () -> ::String
|
212
|
+
end
|
213
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_related_item-instance_method
|
214
|
+
def create_related_item: (
|
215
|
+
case_id: ::String,
|
216
|
+
content: {
|
217
|
+
comment: {
|
218
|
+
body: ::String,
|
219
|
+
content_type: ("Text/Plain")
|
220
|
+
}?,
|
221
|
+
contact: {
|
222
|
+
contact_arn: ::String
|
223
|
+
}?
|
224
|
+
},
|
225
|
+
domain_id: ::String,
|
226
|
+
?performed_by: {
|
227
|
+
user_arn: ::String?
|
228
|
+
},
|
229
|
+
type: ("Contact" | "Comment")
|
230
|
+
) -> _CreateRelatedItemResponseSuccess
|
231
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRelatedItemResponseSuccess
|
232
|
+
|
233
|
+
interface _CreateTemplateResponseSuccess
|
234
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateTemplateResponse]
|
235
|
+
def template_arn: () -> ::String
|
236
|
+
def template_id: () -> ::String
|
237
|
+
end
|
238
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#create_template-instance_method
|
239
|
+
def create_template: (
|
240
|
+
?description: ::String,
|
241
|
+
domain_id: ::String,
|
242
|
+
?layout_configuration: {
|
243
|
+
default_layout: ::String?
|
244
|
+
},
|
245
|
+
name: ::String,
|
246
|
+
?required_fields: Array[
|
247
|
+
{
|
248
|
+
field_id: ::String
|
249
|
+
},
|
250
|
+
],
|
251
|
+
?status: ("Active" | "Inactive")
|
252
|
+
) -> _CreateTemplateResponseSuccess
|
253
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateTemplateResponseSuccess
|
254
|
+
|
255
|
+
interface _DeleteDomainResponseSuccess
|
256
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDomainResponse]
|
257
|
+
end
|
258
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#delete_domain-instance_method
|
259
|
+
def delete_domain: (
|
260
|
+
domain_id: ::String
|
261
|
+
) -> _DeleteDomainResponseSuccess
|
262
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDomainResponseSuccess
|
263
|
+
|
264
|
+
interface _GetCaseResponseSuccess
|
265
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseResponse]
|
266
|
+
def fields: () -> ::Array[Types::FieldValue]
|
267
|
+
def next_token: () -> ::String
|
268
|
+
def tags: () -> ::Hash[::String, ::String]
|
269
|
+
def template_id: () -> ::String
|
270
|
+
end
|
271
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_case-instance_method
|
272
|
+
def get_case: (
|
273
|
+
case_id: ::String,
|
274
|
+
domain_id: ::String,
|
275
|
+
fields: Array[
|
276
|
+
{
|
277
|
+
id: ::String
|
278
|
+
},
|
279
|
+
],
|
280
|
+
?next_token: ::String
|
281
|
+
) -> _GetCaseResponseSuccess
|
282
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseResponseSuccess
|
283
|
+
|
284
|
+
interface _GetCaseAuditEventsResponseSuccess
|
285
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseAuditEventsResponse]
|
286
|
+
def audit_events: () -> ::Array[Types::AuditEvent]
|
287
|
+
def next_token: () -> ::String
|
288
|
+
end
|
289
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_case_audit_events-instance_method
|
290
|
+
def get_case_audit_events: (
|
291
|
+
case_id: ::String,
|
292
|
+
domain_id: ::String,
|
293
|
+
?max_results: ::Integer,
|
294
|
+
?next_token: ::String
|
295
|
+
) -> _GetCaseAuditEventsResponseSuccess
|
296
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseAuditEventsResponseSuccess
|
297
|
+
|
298
|
+
interface _GetCaseEventConfigurationResponseSuccess
|
299
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseEventConfigurationResponse]
|
300
|
+
def event_bridge: () -> Types::EventBridgeConfiguration
|
301
|
+
end
|
302
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_case_event_configuration-instance_method
|
303
|
+
def get_case_event_configuration: (
|
304
|
+
domain_id: ::String
|
305
|
+
) -> _GetCaseEventConfigurationResponseSuccess
|
306
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseEventConfigurationResponseSuccess
|
307
|
+
|
308
|
+
interface _GetDomainResponseSuccess
|
309
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDomainResponse]
|
310
|
+
def created_time: () -> ::Time
|
311
|
+
def domain_arn: () -> ::String
|
312
|
+
def domain_id: () -> ::String
|
313
|
+
def domain_status: () -> ("Active" | "CreationInProgress" | "CreationFailed")
|
314
|
+
def name: () -> ::String
|
315
|
+
def tags: () -> ::Hash[::String, ::String]
|
316
|
+
end
|
317
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_domain-instance_method
|
318
|
+
def get_domain: (
|
319
|
+
domain_id: ::String
|
320
|
+
) -> _GetDomainResponseSuccess
|
321
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDomainResponseSuccess
|
322
|
+
|
323
|
+
interface _GetLayoutResponseSuccess
|
324
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetLayoutResponse]
|
325
|
+
def content: () -> Types::LayoutContent
|
326
|
+
def layout_arn: () -> ::String
|
327
|
+
def layout_id: () -> ::String
|
328
|
+
def name: () -> ::String
|
329
|
+
def tags: () -> ::Hash[::String, ::String]
|
330
|
+
end
|
331
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_layout-instance_method
|
332
|
+
def get_layout: (
|
333
|
+
domain_id: ::String,
|
334
|
+
layout_id: ::String
|
335
|
+
) -> _GetLayoutResponseSuccess
|
336
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLayoutResponseSuccess
|
337
|
+
|
338
|
+
interface _GetTemplateResponseSuccess
|
339
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetTemplateResponse]
|
340
|
+
def description: () -> ::String
|
341
|
+
def layout_configuration: () -> Types::LayoutConfiguration
|
342
|
+
def name: () -> ::String
|
343
|
+
def required_fields: () -> ::Array[Types::RequiredField]
|
344
|
+
def status: () -> ("Active" | "Inactive")
|
345
|
+
def tags: () -> ::Hash[::String, ::String]
|
346
|
+
def template_arn: () -> ::String
|
347
|
+
def template_id: () -> ::String
|
348
|
+
end
|
349
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#get_template-instance_method
|
350
|
+
def get_template: (
|
351
|
+
domain_id: ::String,
|
352
|
+
template_id: ::String
|
353
|
+
) -> _GetTemplateResponseSuccess
|
354
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetTemplateResponseSuccess
|
355
|
+
|
356
|
+
interface _ListCasesForContactResponseSuccess
|
357
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCasesForContactResponse]
|
358
|
+
def cases: () -> ::Array[Types::CaseSummary]
|
359
|
+
def next_token: () -> ::String
|
360
|
+
end
|
361
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_cases_for_contact-instance_method
|
362
|
+
def list_cases_for_contact: (
|
363
|
+
contact_arn: ::String,
|
364
|
+
domain_id: ::String,
|
365
|
+
?max_results: ::Integer,
|
366
|
+
?next_token: ::String
|
367
|
+
) -> _ListCasesForContactResponseSuccess
|
368
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCasesForContactResponseSuccess
|
369
|
+
|
370
|
+
interface _ListDomainsResponseSuccess
|
371
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListDomainsResponse]
|
372
|
+
def domains: () -> ::Array[Types::DomainSummary]
|
373
|
+
def next_token: () -> ::String
|
374
|
+
end
|
375
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_domains-instance_method
|
376
|
+
def list_domains: (
|
377
|
+
?max_results: ::Integer,
|
378
|
+
?next_token: ::String
|
379
|
+
) -> _ListDomainsResponseSuccess
|
380
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDomainsResponseSuccess
|
381
|
+
|
382
|
+
interface _ListFieldOptionsResponseSuccess
|
383
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListFieldOptionsResponse]
|
384
|
+
def next_token: () -> ::String
|
385
|
+
def options: () -> ::Array[Types::FieldOption]
|
386
|
+
end
|
387
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_field_options-instance_method
|
388
|
+
def list_field_options: (
|
389
|
+
domain_id: ::String,
|
390
|
+
field_id: ::String,
|
391
|
+
?max_results: ::Integer,
|
392
|
+
?next_token: ::String,
|
393
|
+
?values: Array[::String]
|
394
|
+
) -> _ListFieldOptionsResponseSuccess
|
395
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFieldOptionsResponseSuccess
|
396
|
+
|
397
|
+
interface _ListFieldsResponseSuccess
|
398
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListFieldsResponse]
|
399
|
+
def fields: () -> ::Array[Types::FieldSummary]
|
400
|
+
def next_token: () -> ::String
|
401
|
+
end
|
402
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_fields-instance_method
|
403
|
+
def list_fields: (
|
404
|
+
domain_id: ::String,
|
405
|
+
?max_results: ::Integer,
|
406
|
+
?next_token: ::String
|
407
|
+
) -> _ListFieldsResponseSuccess
|
408
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFieldsResponseSuccess
|
409
|
+
|
410
|
+
interface _ListLayoutsResponseSuccess
|
411
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListLayoutsResponse]
|
412
|
+
def layouts: () -> ::Array[Types::LayoutSummary]
|
413
|
+
def next_token: () -> ::String
|
414
|
+
end
|
415
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_layouts-instance_method
|
416
|
+
def list_layouts: (
|
417
|
+
domain_id: ::String,
|
418
|
+
?max_results: ::Integer,
|
419
|
+
?next_token: ::String
|
420
|
+
) -> _ListLayoutsResponseSuccess
|
421
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListLayoutsResponseSuccess
|
422
|
+
|
423
|
+
interface _ListTagsForResourceResponseSuccess
|
424
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
425
|
+
def tags: () -> ::Hash[::String, ::String]
|
426
|
+
end
|
427
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_tags_for_resource-instance_method
|
428
|
+
def list_tags_for_resource: (
|
429
|
+
arn: ::String
|
430
|
+
) -> _ListTagsForResourceResponseSuccess
|
431
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
432
|
+
|
433
|
+
interface _ListTemplatesResponseSuccess
|
434
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTemplatesResponse]
|
435
|
+
def next_token: () -> ::String
|
436
|
+
def templates: () -> ::Array[Types::TemplateSummary]
|
437
|
+
end
|
438
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#list_templates-instance_method
|
439
|
+
def list_templates: (
|
440
|
+
domain_id: ::String,
|
441
|
+
?max_results: ::Integer,
|
442
|
+
?next_token: ::String,
|
443
|
+
?status: Array[("Active" | "Inactive")]
|
444
|
+
) -> _ListTemplatesResponseSuccess
|
445
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTemplatesResponseSuccess
|
446
|
+
|
447
|
+
interface _PutCaseEventConfigurationResponseSuccess
|
448
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutCaseEventConfigurationResponse]
|
449
|
+
end
|
450
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#put_case_event_configuration-instance_method
|
451
|
+
def put_case_event_configuration: (
|
452
|
+
domain_id: ::String,
|
453
|
+
event_bridge: {
|
454
|
+
enabled: bool,
|
455
|
+
included_data: {
|
456
|
+
case_data: {
|
457
|
+
fields: Array[
|
458
|
+
{
|
459
|
+
id: ::String
|
460
|
+
},
|
461
|
+
]
|
462
|
+
}?,
|
463
|
+
related_item_data: {
|
464
|
+
include_content: bool
|
465
|
+
}?
|
466
|
+
}?
|
467
|
+
}
|
468
|
+
) -> _PutCaseEventConfigurationResponseSuccess
|
469
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutCaseEventConfigurationResponseSuccess
|
470
|
+
|
471
|
+
interface _SearchCasesResponseSuccess
|
472
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchCasesResponse]
|
473
|
+
def cases: () -> ::Array[Types::SearchCasesResponseItem]
|
474
|
+
def next_token: () -> ::String
|
475
|
+
end
|
476
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#search_cases-instance_method
|
477
|
+
def search_cases: (
|
478
|
+
domain_id: ::String,
|
479
|
+
?fields: Array[
|
480
|
+
{
|
481
|
+
id: ::String
|
482
|
+
},
|
483
|
+
],
|
484
|
+
?filter: {
|
485
|
+
and_all: Array[
|
486
|
+
untyped,
|
487
|
+
]?,
|
488
|
+
field: {
|
489
|
+
contains: {
|
490
|
+
id: ::String,
|
491
|
+
value: {
|
492
|
+
boolean_value: bool?,
|
493
|
+
double_value: ::Float?,
|
494
|
+
empty_value: {
|
495
|
+
}?,
|
496
|
+
string_value: ::String?,
|
497
|
+
user_arn_value: ::String?
|
498
|
+
}
|
499
|
+
}?,
|
500
|
+
equal_to: {
|
501
|
+
id: ::String,
|
502
|
+
value: {
|
503
|
+
boolean_value: bool?,
|
504
|
+
double_value: ::Float?,
|
505
|
+
empty_value: {
|
506
|
+
}?,
|
507
|
+
string_value: ::String?,
|
508
|
+
user_arn_value: ::String?
|
509
|
+
}
|
510
|
+
}?,
|
511
|
+
greater_than: {
|
512
|
+
id: ::String,
|
513
|
+
value: {
|
514
|
+
boolean_value: bool?,
|
515
|
+
double_value: ::Float?,
|
516
|
+
empty_value: {
|
517
|
+
}?,
|
518
|
+
string_value: ::String?,
|
519
|
+
user_arn_value: ::String?
|
520
|
+
}
|
521
|
+
}?,
|
522
|
+
greater_than_or_equal_to: {
|
523
|
+
id: ::String,
|
524
|
+
value: {
|
525
|
+
boolean_value: bool?,
|
526
|
+
double_value: ::Float?,
|
527
|
+
empty_value: {
|
528
|
+
}?,
|
529
|
+
string_value: ::String?,
|
530
|
+
user_arn_value: ::String?
|
531
|
+
}
|
532
|
+
}?,
|
533
|
+
less_than: {
|
534
|
+
id: ::String,
|
535
|
+
value: {
|
536
|
+
boolean_value: bool?,
|
537
|
+
double_value: ::Float?,
|
538
|
+
empty_value: {
|
539
|
+
}?,
|
540
|
+
string_value: ::String?,
|
541
|
+
user_arn_value: ::String?
|
542
|
+
}
|
543
|
+
}?,
|
544
|
+
less_than_or_equal_to: {
|
545
|
+
id: ::String,
|
546
|
+
value: {
|
547
|
+
boolean_value: bool?,
|
548
|
+
double_value: ::Float?,
|
549
|
+
empty_value: {
|
550
|
+
}?,
|
551
|
+
string_value: ::String?,
|
552
|
+
user_arn_value: ::String?
|
553
|
+
}
|
554
|
+
}?
|
555
|
+
}?,
|
556
|
+
not: untyped?,
|
557
|
+
or_all: Array[
|
558
|
+
untyped,
|
559
|
+
]?
|
560
|
+
},
|
561
|
+
?max_results: ::Integer,
|
562
|
+
?next_token: ::String,
|
563
|
+
?search_term: ::String,
|
564
|
+
?sorts: Array[
|
565
|
+
{
|
566
|
+
field_id: ::String,
|
567
|
+
sort_order: ("Asc" | "Desc")
|
568
|
+
},
|
569
|
+
]
|
570
|
+
) -> _SearchCasesResponseSuccess
|
571
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchCasesResponseSuccess
|
572
|
+
|
573
|
+
interface _SearchRelatedItemsResponseSuccess
|
574
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchRelatedItemsResponse]
|
575
|
+
def next_token: () -> ::String
|
576
|
+
def related_items: () -> ::Array[Types::SearchRelatedItemsResponseItem]
|
577
|
+
end
|
578
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#search_related_items-instance_method
|
579
|
+
def search_related_items: (
|
580
|
+
case_id: ::String,
|
581
|
+
domain_id: ::String,
|
582
|
+
?filters: Array[
|
583
|
+
{
|
584
|
+
comment: {
|
585
|
+
}?,
|
586
|
+
contact: {
|
587
|
+
channel: Array[::String]?,
|
588
|
+
contact_arn: ::String?
|
589
|
+
}?
|
590
|
+
},
|
591
|
+
],
|
592
|
+
?max_results: ::Integer,
|
593
|
+
?next_token: ::String
|
594
|
+
) -> _SearchRelatedItemsResponseSuccess
|
595
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchRelatedItemsResponseSuccess
|
596
|
+
|
597
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#tag_resource-instance_method
|
598
|
+
def tag_resource: (
|
599
|
+
arn: ::String,
|
600
|
+
tags: Hash[::String, ::String]
|
601
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
602
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
603
|
+
|
604
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#untag_resource-instance_method
|
605
|
+
def untag_resource: (
|
606
|
+
arn: ::String,
|
607
|
+
tag_keys: Array[::String]
|
608
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
609
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
610
|
+
|
611
|
+
interface _UpdateCaseResponseSuccess
|
612
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCaseResponse]
|
613
|
+
end
|
614
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#update_case-instance_method
|
615
|
+
def update_case: (
|
616
|
+
case_id: ::String,
|
617
|
+
domain_id: ::String,
|
618
|
+
fields: Array[
|
619
|
+
{
|
620
|
+
id: ::String,
|
621
|
+
value: {
|
622
|
+
boolean_value: bool?,
|
623
|
+
double_value: ::Float?,
|
624
|
+
empty_value: {
|
625
|
+
}?,
|
626
|
+
string_value: ::String?,
|
627
|
+
user_arn_value: ::String?
|
628
|
+
}
|
629
|
+
},
|
630
|
+
],
|
631
|
+
?performed_by: {
|
632
|
+
user_arn: ::String?
|
633
|
+
}
|
634
|
+
) -> _UpdateCaseResponseSuccess
|
635
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCaseResponseSuccess
|
636
|
+
|
637
|
+
interface _UpdateFieldResponseSuccess
|
638
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateFieldResponse]
|
639
|
+
end
|
640
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#update_field-instance_method
|
641
|
+
def update_field: (
|
642
|
+
?description: ::String,
|
643
|
+
domain_id: ::String,
|
644
|
+
field_id: ::String,
|
645
|
+
?name: ::String
|
646
|
+
) -> _UpdateFieldResponseSuccess
|
647
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateFieldResponseSuccess
|
648
|
+
|
649
|
+
interface _UpdateLayoutResponseSuccess
|
650
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateLayoutResponse]
|
651
|
+
end
|
652
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#update_layout-instance_method
|
653
|
+
def update_layout: (
|
654
|
+
?content: {
|
655
|
+
basic: {
|
656
|
+
more_info: {
|
657
|
+
sections: Array[
|
658
|
+
{
|
659
|
+
field_group: {
|
660
|
+
fields: Array[
|
661
|
+
{
|
662
|
+
id: ::String
|
663
|
+
},
|
664
|
+
],
|
665
|
+
name: ::String?
|
666
|
+
}?
|
667
|
+
},
|
668
|
+
]?
|
669
|
+
}?,
|
670
|
+
top_panel: {
|
671
|
+
sections: Array[
|
672
|
+
{
|
673
|
+
field_group: {
|
674
|
+
fields: Array[
|
675
|
+
{
|
676
|
+
id: ::String
|
677
|
+
},
|
678
|
+
],
|
679
|
+
name: ::String?
|
680
|
+
}?
|
681
|
+
},
|
682
|
+
]?
|
683
|
+
}?
|
684
|
+
}?
|
685
|
+
},
|
686
|
+
domain_id: ::String,
|
687
|
+
layout_id: ::String,
|
688
|
+
?name: ::String
|
689
|
+
) -> _UpdateLayoutResponseSuccess
|
690
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateLayoutResponseSuccess
|
691
|
+
|
692
|
+
interface _UpdateTemplateResponseSuccess
|
693
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateTemplateResponse]
|
694
|
+
end
|
695
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCases/Client.html#update_template-instance_method
|
696
|
+
def update_template: (
|
697
|
+
?description: ::String,
|
698
|
+
domain_id: ::String,
|
699
|
+
?layout_configuration: {
|
700
|
+
default_layout: ::String?
|
701
|
+
},
|
702
|
+
?name: ::String,
|
703
|
+
?required_fields: Array[
|
704
|
+
{
|
705
|
+
field_id: ::String
|
706
|
+
},
|
707
|
+
],
|
708
|
+
?status: ("Active" | "Inactive"),
|
709
|
+
template_id: ::String
|
710
|
+
) -> _UpdateTemplateResponseSuccess
|
711
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateTemplateResponseSuccess
|
712
|
+
end
|
713
|
+
end
|
714
|
+
end
|
715
|
+
|