aws-sdk-connectparticipant 1.0.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 +7 -0
- data/lib/aws-sdk-connectparticipant.rb +47 -0
- data/lib/aws-sdk-connectparticipant/client.rb +555 -0
- data/lib/aws-sdk-connectparticipant/client_api.rb +230 -0
- data/lib/aws-sdk-connectparticipant/customizations.rb +0 -0
- data/lib/aws-sdk-connectparticipant/errors.rb +78 -0
- data/lib/aws-sdk-connectparticipant/resource.rb +23 -0
- data/lib/aws-sdk-connectparticipant/types.rb +481 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: '0408490c61eb842f40572525c9c274ac4c7fd354'
|
4
|
+
data.tar.gz: 33f7fc05e0cf7508636ce0b0e872ccd02e525074
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3e4198016c47fc9bba2b3e350a0914ebaa17c990b4d37231755bae109c44cb22ddc098f1f794bf1d6e09824f8fff9982633c62d6251384c18919118f3eb7cdfe
|
7
|
+
data.tar.gz: 76eb9ecd97e1ad2901495ff257b5b3d3f73633008b79858e50fc9ab7a7ebec8cf4e9ae83ec5fdc808f988fdafc4cc2763266d51a31f9af675d156b2e6b021b42
|
@@ -0,0 +1,47 @@
|
|
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/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-connectparticipant/types'
|
12
|
+
require_relative 'aws-sdk-connectparticipant/client_api'
|
13
|
+
require_relative 'aws-sdk-connectparticipant/client'
|
14
|
+
require_relative 'aws-sdk-connectparticipant/errors'
|
15
|
+
require_relative 'aws-sdk-connectparticipant/resource'
|
16
|
+
require_relative 'aws-sdk-connectparticipant/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Connect Participant Service. This module is available in the
|
19
|
+
# `aws-sdk-connectparticipant` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon Connect Participant Service all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::ConnectParticipant::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::ConnectParticipant
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,555 @@
|
|
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/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
|
+
|
30
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:connectparticipant)
|
31
|
+
|
32
|
+
module Aws::ConnectParticipant
|
33
|
+
class Client < Seahorse::Client::Base
|
34
|
+
|
35
|
+
include Aws::ClientStubs
|
36
|
+
|
37
|
+
@identifier = :connectparticipant
|
38
|
+
|
39
|
+
set_api(ClientApi::API)
|
40
|
+
|
41
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
42
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
43
|
+
add_plugin(Aws::Plugins::Logging)
|
44
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
45
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
46
|
+
add_plugin(Aws::Plugins::UserAgent)
|
47
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
48
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
49
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
50
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
51
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
52
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
53
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
54
|
+
add_plugin(Aws::Plugins::StubResponses)
|
55
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
56
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
60
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
61
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
|
+
|
63
|
+
# @overload initialize(options)
|
64
|
+
# @param [Hash] options
|
65
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
66
|
+
# Your AWS credentials. This can be an instance of any one of the
|
67
|
+
# following classes:
|
68
|
+
#
|
69
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
70
|
+
# credentials.
|
71
|
+
#
|
72
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
73
|
+
# from an EC2 IMDS on an EC2 instance.
|
74
|
+
#
|
75
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
76
|
+
# shared file, such as `~/.aws/config`.
|
77
|
+
#
|
78
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
79
|
+
#
|
80
|
+
# When `:credentials` are not configured directly, the following
|
81
|
+
# locations will be searched for credentials:
|
82
|
+
#
|
83
|
+
# * `Aws.config[:credentials]`
|
84
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
85
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
86
|
+
# * `~/.aws/credentials`
|
87
|
+
# * `~/.aws/config`
|
88
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
89
|
+
# very aggressive. Construct and pass an instance of
|
90
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
91
|
+
# timeouts.
|
92
|
+
#
|
93
|
+
# @option options [required, String] :region
|
94
|
+
# The AWS region to connect to. The configured `:region` is
|
95
|
+
# used to determine the service `:endpoint`. When not passed,
|
96
|
+
# a default `:region` is search for in the following locations:
|
97
|
+
#
|
98
|
+
# * `Aws.config[:region]`
|
99
|
+
# * `ENV['AWS_REGION']`
|
100
|
+
# * `ENV['AMAZON_REGION']`
|
101
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
102
|
+
# * `~/.aws/credentials`
|
103
|
+
# * `~/.aws/config`
|
104
|
+
#
|
105
|
+
# @option options [String] :access_key_id
|
106
|
+
#
|
107
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
108
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
109
|
+
# the background every 60 secs (default). Defaults to `false`.
|
110
|
+
#
|
111
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
112
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
113
|
+
# this client.
|
114
|
+
#
|
115
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
116
|
+
# Allows you to provide an identifier for this client which will be attached to
|
117
|
+
# all generated client side metrics. Defaults to an empty string.
|
118
|
+
#
|
119
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
120
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
121
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
122
|
+
#
|
123
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
124
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
125
|
+
# agent is running on, where client metrics will be published via UDP.
|
126
|
+
#
|
127
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
128
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
129
|
+
# will use the Client Side Monitoring Agent Publisher.
|
130
|
+
#
|
131
|
+
# @option options [Boolean] :convert_params (true)
|
132
|
+
# When `true`, an attempt is made to coerce request parameters into
|
133
|
+
# the required types.
|
134
|
+
#
|
135
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
|
+
# Set to true to disable SDK automatically adding host prefix
|
137
|
+
# to default service endpoint when available.
|
138
|
+
#
|
139
|
+
# @option options [String] :endpoint
|
140
|
+
# The client endpoint is normally constructed from the `:region`
|
141
|
+
# option. You should only configure an `:endpoint` when connecting
|
142
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
143
|
+
#
|
144
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
146
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
147
|
+
#
|
148
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
149
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
150
|
+
#
|
151
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
152
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
153
|
+
# Use this option to config the time interval in seconds for making
|
154
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
155
|
+
#
|
156
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
158
|
+
#
|
159
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
|
+
# The log formatter.
|
161
|
+
#
|
162
|
+
# @option options [Symbol] :log_level (:info)
|
163
|
+
# The log level to send messages to the `:logger` at.
|
164
|
+
#
|
165
|
+
# @option options [Logger] :logger
|
166
|
+
# The Logger instance to send log messages to. If this option
|
167
|
+
# is not set, logging will be disabled.
|
168
|
+
#
|
169
|
+
# @option options [String] :profile ("default")
|
170
|
+
# Used when loading credentials from the shared credentials file
|
171
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
|
+
#
|
173
|
+
# @option options [Float] :retry_base_delay (0.3)
|
174
|
+
# The base delay in seconds used by the default backoff function.
|
175
|
+
#
|
176
|
+
# @option options [Symbol] :retry_jitter (:none)
|
177
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
178
|
+
#
|
179
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
|
+
#
|
181
|
+
# @option options [Integer] :retry_limit (3)
|
182
|
+
# The maximum number of times to retry failed requests. Only
|
183
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
|
+
# are retried. Generally, these are throttling errors, data
|
185
|
+
# checksum errors, networking errors, timeout errors and auth
|
186
|
+
# errors from expired credentials.
|
187
|
+
#
|
188
|
+
# @option options [Integer] :retry_max_delay (0)
|
189
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
190
|
+
#
|
191
|
+
# @option options [String] :secret_access_key
|
192
|
+
#
|
193
|
+
# @option options [String] :session_token
|
194
|
+
#
|
195
|
+
# @option options [Boolean] :stub_responses (false)
|
196
|
+
# Causes the client to return stubbed responses. By default
|
197
|
+
# fake responses are generated and returned. You can specify
|
198
|
+
# the response data to return or errors to raise by calling
|
199
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
200
|
+
#
|
201
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
202
|
+
# requests are made, and retries are disabled.
|
203
|
+
#
|
204
|
+
# @option options [Boolean] :validate_params (true)
|
205
|
+
# When `true`, request parameters are validated before
|
206
|
+
# sending the request.
|
207
|
+
#
|
208
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
209
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
210
|
+
#
|
211
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
+
# seconds to wait when opening a HTTP session before rasing a
|
213
|
+
# `Timeout::Error`.
|
214
|
+
#
|
215
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
216
|
+
# number of seconds to wait for response data. This value can
|
217
|
+
# safely be set
|
218
|
+
# per-request on the session yeidled by {#session_for}.
|
219
|
+
#
|
220
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
+
# seconds a connection is allowed to sit idble before it is
|
222
|
+
# considered stale. Stale connections are closed and removed
|
223
|
+
# from the pool before making a request.
|
224
|
+
#
|
225
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
226
|
+
# seconds to wait for a 100-continue response before sending the
|
227
|
+
# request body. This option has no effect unless the request has
|
228
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
|
+
# disables this behaviour. This value can safely be set per
|
230
|
+
# request on the session yeidled by {#session_for}.
|
231
|
+
#
|
232
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
|
+
# HTTP debug output will be sent to the `:logger`.
|
234
|
+
#
|
235
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
236
|
+
# SSL peer certificates are verified when establishing a
|
237
|
+
# connection.
|
238
|
+
#
|
239
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
240
|
+
# certificate authority bundle file that should be used when
|
241
|
+
# verifying peer certificates. If you do not pass
|
242
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
243
|
+
# will be used if available.
|
244
|
+
#
|
245
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
246
|
+
# directory that contains the unbundled SSL certificate
|
247
|
+
# authority files for verifying peer certificates. If you do
|
248
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
249
|
+
# system default will be used if available.
|
250
|
+
#
|
251
|
+
def initialize(*args)
|
252
|
+
super
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!group API Operations
|
256
|
+
|
257
|
+
# Creates the participant's connection. Note that ParticipantToken is
|
258
|
+
# used for invoking this API instead of ConnectionToken.
|
259
|
+
#
|
260
|
+
# The participant token is valid for the lifetime of the participant –
|
261
|
+
# until the they are part of a contact.
|
262
|
+
#
|
263
|
+
# The response URL for `WEBSOCKET` Type has a connect expiry timeout of
|
264
|
+
# 100s. Clients must manually connect to the returned websocket URL and
|
265
|
+
# subscribe to the desired topic.
|
266
|
+
#
|
267
|
+
# For chat, you need to publish the following on the established
|
268
|
+
# websocket connection:
|
269
|
+
#
|
270
|
+
# `\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}`
|
271
|
+
#
|
272
|
+
# Upon websocket URL expiry, as specified in the response
|
273
|
+
# ConnectionExpiry parameter, clients need to call this API again to
|
274
|
+
# obtain a new websocket URL and perform the same steps as before.
|
275
|
+
#
|
276
|
+
# @option params [required, Array<String>] :type
|
277
|
+
# Type of connection information required.
|
278
|
+
#
|
279
|
+
# @option params [required, String] :participant_token
|
280
|
+
# Participant Token as obtained from [StartChatContact][1] API response.
|
281
|
+
#
|
282
|
+
#
|
283
|
+
#
|
284
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContactResponse.html
|
285
|
+
#
|
286
|
+
# @return [Types::CreateParticipantConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
287
|
+
#
|
288
|
+
# * {Types::CreateParticipantConnectionResponse#websocket #websocket} => Types::Websocket
|
289
|
+
# * {Types::CreateParticipantConnectionResponse#connection_credentials #connection_credentials} => Types::ConnectionCredentials
|
290
|
+
#
|
291
|
+
# @example Request syntax with placeholder values
|
292
|
+
#
|
293
|
+
# resp = client.create_participant_connection({
|
294
|
+
# type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
|
295
|
+
# participant_token: "ParticipantToken", # required
|
296
|
+
# })
|
297
|
+
#
|
298
|
+
# @example Response structure
|
299
|
+
#
|
300
|
+
# resp.websocket.url #=> String
|
301
|
+
# resp.websocket.connection_expiry #=> String
|
302
|
+
# resp.connection_credentials.connection_token #=> String
|
303
|
+
# resp.connection_credentials.expiry #=> String
|
304
|
+
#
|
305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnection AWS API Documentation
|
306
|
+
#
|
307
|
+
# @overload create_participant_connection(params = {})
|
308
|
+
# @param [Hash] params ({})
|
309
|
+
def create_participant_connection(params = {}, options = {})
|
310
|
+
req = build_request(:create_participant_connection, params)
|
311
|
+
req.send_request(options)
|
312
|
+
end
|
313
|
+
|
314
|
+
# Disconnects a participant. Note that ConnectionToken is used for
|
315
|
+
# invoking this API instead of ParticipantToken.
|
316
|
+
#
|
317
|
+
# @option params [String] :client_token
|
318
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
319
|
+
# idempotency of the request.
|
320
|
+
#
|
321
|
+
# **A suitable default value is auto-generated.** You should normally
|
322
|
+
# not need to pass this option.**
|
323
|
+
#
|
324
|
+
# @option params [required, String] :connection_token
|
325
|
+
# The authentication token associated with the participant's
|
326
|
+
# connection.
|
327
|
+
#
|
328
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
329
|
+
#
|
330
|
+
# @example Request syntax with placeholder values
|
331
|
+
#
|
332
|
+
# resp = client.disconnect_participant({
|
333
|
+
# client_token: "ClientToken",
|
334
|
+
# connection_token: "ParticipantToken", # required
|
335
|
+
# })
|
336
|
+
#
|
337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipant AWS API Documentation
|
338
|
+
#
|
339
|
+
# @overload disconnect_participant(params = {})
|
340
|
+
# @param [Hash] params ({})
|
341
|
+
def disconnect_participant(params = {}, options = {})
|
342
|
+
req = build_request(:disconnect_participant, params)
|
343
|
+
req.send_request(options)
|
344
|
+
end
|
345
|
+
|
346
|
+
# Retrieves a transcript of the session. Note that ConnectionToken is
|
347
|
+
# used for invoking this API instead of ParticipantToken.
|
348
|
+
#
|
349
|
+
# @option params [String] :contact_id
|
350
|
+
# The contactId from the current contact chain for which transcript is
|
351
|
+
# needed.
|
352
|
+
#
|
353
|
+
# @option params [Integer] :max_results
|
354
|
+
# The maximum number of results to return in the page. Default: 10.
|
355
|
+
#
|
356
|
+
# @option params [String] :next_token
|
357
|
+
# The pagination token. Use the value returned previously in the next
|
358
|
+
# subsequent request to retrieve the next set of results.
|
359
|
+
#
|
360
|
+
# @option params [String] :scan_direction
|
361
|
+
# The direction from StartPosition from which to retrieve message.
|
362
|
+
# Default: BACKWARD when no StartPosition is provided, FORWARD with
|
363
|
+
# StartPosition.
|
364
|
+
#
|
365
|
+
# @option params [String] :sort_order
|
366
|
+
# The sort order for the records. Default: DESCENDING.
|
367
|
+
#
|
368
|
+
# @option params [Types::StartPosition] :start_position
|
369
|
+
# A filtering option for where to start.
|
370
|
+
#
|
371
|
+
# @option params [required, String] :connection_token
|
372
|
+
# The authentication token associated with the participant's
|
373
|
+
# connection.
|
374
|
+
#
|
375
|
+
# @return [Types::GetTranscriptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
|
+
#
|
377
|
+
# * {Types::GetTranscriptResponse#initial_contact_id #initial_contact_id} => String
|
378
|
+
# * {Types::GetTranscriptResponse#transcript #transcript} => Array<Types::Item>
|
379
|
+
# * {Types::GetTranscriptResponse#next_token #next_token} => String
|
380
|
+
#
|
381
|
+
# @example Request syntax with placeholder values
|
382
|
+
#
|
383
|
+
# resp = client.get_transcript({
|
384
|
+
# contact_id: "ContactId",
|
385
|
+
# max_results: 1,
|
386
|
+
# next_token: "NextToken",
|
387
|
+
# scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
|
388
|
+
# sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
|
389
|
+
# start_position: {
|
390
|
+
# id: "ChatItemId",
|
391
|
+
# absolute_time: "Instant",
|
392
|
+
# most_recent: 1,
|
393
|
+
# },
|
394
|
+
# connection_token: "ParticipantToken", # required
|
395
|
+
# })
|
396
|
+
#
|
397
|
+
# @example Response structure
|
398
|
+
#
|
399
|
+
# resp.initial_contact_id #=> String
|
400
|
+
# resp.transcript #=> Array
|
401
|
+
# resp.transcript[0].absolute_time #=> String
|
402
|
+
# resp.transcript[0].content #=> String
|
403
|
+
# resp.transcript[0].content_type #=> String
|
404
|
+
# resp.transcript[0].id #=> String
|
405
|
+
# resp.transcript[0].type #=> String, one of "MESSAGE", "EVENT", "CONNECTION_ACK"
|
406
|
+
# resp.transcript[0].participant_id #=> String
|
407
|
+
# resp.transcript[0].display_name #=> String
|
408
|
+
# resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM"
|
409
|
+
# resp.next_token #=> String
|
410
|
+
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscript AWS API Documentation
|
412
|
+
#
|
413
|
+
# @overload get_transcript(params = {})
|
414
|
+
# @param [Hash] params ({})
|
415
|
+
def get_transcript(params = {}, options = {})
|
416
|
+
req = build_request(:get_transcript, params)
|
417
|
+
req.send_request(options)
|
418
|
+
end
|
419
|
+
|
420
|
+
# Sends an event. Note that ConnectionToken is used for invoking this
|
421
|
+
# API instead of ParticipantToken.
|
422
|
+
#
|
423
|
+
# @option params [required, String] :content_type
|
424
|
+
# The content type of the request. Supported types are:
|
425
|
+
#
|
426
|
+
# * application/vnd.amazonaws.connect.event.typing
|
427
|
+
#
|
428
|
+
# * application/vnd.amazonaws.connect.event.connection.acknowledged
|
429
|
+
#
|
430
|
+
# @option params [String] :content
|
431
|
+
# The content of the event to be sent (for example, message text). This
|
432
|
+
# is not yet supported.
|
433
|
+
#
|
434
|
+
# @option params [String] :client_token
|
435
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
436
|
+
# idempotency of the request.
|
437
|
+
#
|
438
|
+
# **A suitable default value is auto-generated.** You should normally
|
439
|
+
# not need to pass this option.**
|
440
|
+
#
|
441
|
+
# @option params [required, String] :connection_token
|
442
|
+
# The authentication token associated with the participant's
|
443
|
+
# connection.
|
444
|
+
#
|
445
|
+
# @return [Types::SendEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
446
|
+
#
|
447
|
+
# * {Types::SendEventResponse#id #id} => String
|
448
|
+
# * {Types::SendEventResponse#absolute_time #absolute_time} => String
|
449
|
+
#
|
450
|
+
# @example Request syntax with placeholder values
|
451
|
+
#
|
452
|
+
# resp = client.send_event({
|
453
|
+
# content_type: "ChatContentType", # required
|
454
|
+
# content: "ChatContent",
|
455
|
+
# client_token: "ClientToken",
|
456
|
+
# connection_token: "ParticipantToken", # required
|
457
|
+
# })
|
458
|
+
#
|
459
|
+
# @example Response structure
|
460
|
+
#
|
461
|
+
# resp.id #=> String
|
462
|
+
# resp.absolute_time #=> String
|
463
|
+
#
|
464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEvent AWS API Documentation
|
465
|
+
#
|
466
|
+
# @overload send_event(params = {})
|
467
|
+
# @param [Hash] params ({})
|
468
|
+
def send_event(params = {}, options = {})
|
469
|
+
req = build_request(:send_event, params)
|
470
|
+
req.send_request(options)
|
471
|
+
end
|
472
|
+
|
473
|
+
# Sends a message. Note that ConnectionToken is used for invoking this
|
474
|
+
# API instead of ParticipantToken.
|
475
|
+
#
|
476
|
+
# @option params [required, String] :content_type
|
477
|
+
# The type of the content. Supported types are text/plain.
|
478
|
+
#
|
479
|
+
# @option params [required, String] :content
|
480
|
+
# The content of the message.
|
481
|
+
#
|
482
|
+
# @option params [String] :client_token
|
483
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
484
|
+
# idempotency of the request.
|
485
|
+
#
|
486
|
+
# **A suitable default value is auto-generated.** You should normally
|
487
|
+
# not need to pass this option.**
|
488
|
+
#
|
489
|
+
# @option params [required, String] :connection_token
|
490
|
+
# The authentication token associated with the connection.
|
491
|
+
#
|
492
|
+
# @return [Types::SendMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
493
|
+
#
|
494
|
+
# * {Types::SendMessageResponse#id #id} => String
|
495
|
+
# * {Types::SendMessageResponse#absolute_time #absolute_time} => String
|
496
|
+
#
|
497
|
+
# @example Request syntax with placeholder values
|
498
|
+
#
|
499
|
+
# resp = client.send_message({
|
500
|
+
# content_type: "ChatContentType", # required
|
501
|
+
# content: "ChatContent", # required
|
502
|
+
# client_token: "ClientToken",
|
503
|
+
# connection_token: "ParticipantToken", # required
|
504
|
+
# })
|
505
|
+
#
|
506
|
+
# @example Response structure
|
507
|
+
#
|
508
|
+
# resp.id #=> String
|
509
|
+
# resp.absolute_time #=> String
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessage AWS API Documentation
|
512
|
+
#
|
513
|
+
# @overload send_message(params = {})
|
514
|
+
# @param [Hash] params ({})
|
515
|
+
def send_message(params = {}, options = {})
|
516
|
+
req = build_request(:send_message, params)
|
517
|
+
req.send_request(options)
|
518
|
+
end
|
519
|
+
|
520
|
+
# @!endgroup
|
521
|
+
|
522
|
+
# @param params ({})
|
523
|
+
# @api private
|
524
|
+
def build_request(operation_name, params = {})
|
525
|
+
handlers = @handlers.for(operation_name)
|
526
|
+
context = Seahorse::Client::RequestContext.new(
|
527
|
+
operation_name: operation_name,
|
528
|
+
operation: config.api.operation(operation_name),
|
529
|
+
client: self,
|
530
|
+
params: params,
|
531
|
+
config: config)
|
532
|
+
context[:gem_name] = 'aws-sdk-connectparticipant'
|
533
|
+
context[:gem_version] = '1.0.0'
|
534
|
+
Seahorse::Client::Request.new(handlers, context)
|
535
|
+
end
|
536
|
+
|
537
|
+
# @api private
|
538
|
+
# @deprecated
|
539
|
+
def waiter_names
|
540
|
+
[]
|
541
|
+
end
|
542
|
+
|
543
|
+
class << self
|
544
|
+
|
545
|
+
# @api private
|
546
|
+
attr_reader :identifier
|
547
|
+
|
548
|
+
# @api private
|
549
|
+
def errors_module
|
550
|
+
Errors
|
551
|
+
end
|
552
|
+
|
553
|
+
end
|
554
|
+
end
|
555
|
+
end
|