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
@@ -0,0 +1,230 @@
|
|
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
|
+
module Aws::ConnectParticipant
|
9
|
+
# @api private
|
10
|
+
module ClientApi
|
11
|
+
|
12
|
+
include Seahorse::Model
|
13
|
+
|
14
|
+
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
15
|
+
ChatContent = Shapes::StringShape.new(name: 'ChatContent')
|
16
|
+
ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
|
17
|
+
ChatItemId = Shapes::StringShape.new(name: 'ChatItemId')
|
18
|
+
ChatItemType = Shapes::StringShape.new(name: 'ChatItemType')
|
19
|
+
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
|
20
|
+
ConnectionCredentials = Shapes::StructureShape.new(name: 'ConnectionCredentials')
|
21
|
+
ConnectionType = Shapes::StringShape.new(name: 'ConnectionType')
|
22
|
+
ConnectionTypeList = Shapes::ListShape.new(name: 'ConnectionTypeList')
|
23
|
+
ContactId = Shapes::StringShape.new(name: 'ContactId')
|
24
|
+
CreateParticipantConnectionRequest = Shapes::StructureShape.new(name: 'CreateParticipantConnectionRequest')
|
25
|
+
CreateParticipantConnectionResponse = Shapes::StructureShape.new(name: 'CreateParticipantConnectionResponse')
|
26
|
+
DisconnectParticipantRequest = Shapes::StructureShape.new(name: 'DisconnectParticipantRequest')
|
27
|
+
DisconnectParticipantResponse = Shapes::StructureShape.new(name: 'DisconnectParticipantResponse')
|
28
|
+
DisplayName = Shapes::StringShape.new(name: 'DisplayName')
|
29
|
+
GetTranscriptRequest = Shapes::StructureShape.new(name: 'GetTranscriptRequest')
|
30
|
+
GetTranscriptResponse = Shapes::StructureShape.new(name: 'GetTranscriptResponse')
|
31
|
+
ISO8601Datetime = Shapes::StringShape.new(name: 'ISO8601Datetime')
|
32
|
+
Instant = Shapes::StringShape.new(name: 'Instant')
|
33
|
+
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
34
|
+
Item = Shapes::StructureShape.new(name: 'Item')
|
35
|
+
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
36
|
+
Message = Shapes::StringShape.new(name: 'Message')
|
37
|
+
MostRecent = Shapes::IntegerShape.new(name: 'MostRecent')
|
38
|
+
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
39
|
+
ParticipantId = Shapes::StringShape.new(name: 'ParticipantId')
|
40
|
+
ParticipantRole = Shapes::StringShape.new(name: 'ParticipantRole')
|
41
|
+
ParticipantToken = Shapes::StringShape.new(name: 'ParticipantToken')
|
42
|
+
PreSignedConnectionUrl = Shapes::StringShape.new(name: 'PreSignedConnectionUrl')
|
43
|
+
Reason = Shapes::StringShape.new(name: 'Reason')
|
44
|
+
ScanDirection = Shapes::StringShape.new(name: 'ScanDirection')
|
45
|
+
SendEventRequest = Shapes::StructureShape.new(name: 'SendEventRequest')
|
46
|
+
SendEventResponse = Shapes::StructureShape.new(name: 'SendEventResponse')
|
47
|
+
SendMessageRequest = Shapes::StructureShape.new(name: 'SendMessageRequest')
|
48
|
+
SendMessageResponse = Shapes::StructureShape.new(name: 'SendMessageResponse')
|
49
|
+
SortKey = Shapes::StringShape.new(name: 'SortKey')
|
50
|
+
StartPosition = Shapes::StructureShape.new(name: 'StartPosition')
|
51
|
+
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
52
|
+
Transcript = Shapes::ListShape.new(name: 'Transcript')
|
53
|
+
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
54
|
+
Websocket = Shapes::StructureShape.new(name: 'Websocket')
|
55
|
+
|
56
|
+
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
57
|
+
AccessDeniedException.struct_class = Types::AccessDeniedException
|
58
|
+
|
59
|
+
ConnectionCredentials.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ConnectionToken"))
|
60
|
+
ConnectionCredentials.add_member(:expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "Expiry"))
|
61
|
+
ConnectionCredentials.struct_class = Types::ConnectionCredentials
|
62
|
+
|
63
|
+
ConnectionTypeList.member = Shapes::ShapeRef.new(shape: ConnectionType)
|
64
|
+
|
65
|
+
CreateParticipantConnectionRequest.add_member(:type, Shapes::ShapeRef.new(shape: ConnectionTypeList, required: true, location_name: "Type"))
|
66
|
+
CreateParticipantConnectionRequest.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
67
|
+
CreateParticipantConnectionRequest.struct_class = Types::CreateParticipantConnectionRequest
|
68
|
+
|
69
|
+
CreateParticipantConnectionResponse.add_member(:websocket, Shapes::ShapeRef.new(shape: Websocket, location_name: "Websocket"))
|
70
|
+
CreateParticipantConnectionResponse.add_member(:connection_credentials, Shapes::ShapeRef.new(shape: ConnectionCredentials, location_name: "ConnectionCredentials"))
|
71
|
+
CreateParticipantConnectionResponse.struct_class = Types::CreateParticipantConnectionResponse
|
72
|
+
|
73
|
+
DisconnectParticipantRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
74
|
+
DisconnectParticipantRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
75
|
+
DisconnectParticipantRequest.struct_class = Types::DisconnectParticipantRequest
|
76
|
+
|
77
|
+
DisconnectParticipantResponse.struct_class = Types::DisconnectParticipantResponse
|
78
|
+
|
79
|
+
GetTranscriptRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
80
|
+
GetTranscriptRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
|
81
|
+
GetTranscriptRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
82
|
+
GetTranscriptRequest.add_member(:scan_direction, Shapes::ShapeRef.new(shape: ScanDirection, location_name: "ScanDirection"))
|
83
|
+
GetTranscriptRequest.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortKey, location_name: "SortOrder"))
|
84
|
+
GetTranscriptRequest.add_member(:start_position, Shapes::ShapeRef.new(shape: StartPosition, location_name: "StartPosition"))
|
85
|
+
GetTranscriptRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
86
|
+
GetTranscriptRequest.struct_class = Types::GetTranscriptRequest
|
87
|
+
|
88
|
+
GetTranscriptResponse.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "InitialContactId"))
|
89
|
+
GetTranscriptResponse.add_member(:transcript, Shapes::ShapeRef.new(shape: Transcript, location_name: "Transcript"))
|
90
|
+
GetTranscriptResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
91
|
+
GetTranscriptResponse.struct_class = Types::GetTranscriptResponse
|
92
|
+
|
93
|
+
InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
94
|
+
InternalServerException.struct_class = Types::InternalServerException
|
95
|
+
|
96
|
+
Item.add_member(:absolute_time, Shapes::ShapeRef.new(shape: Instant, location_name: "AbsoluteTime"))
|
97
|
+
Item.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, location_name: "Content"))
|
98
|
+
Item.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, location_name: "ContentType"))
|
99
|
+
Item.add_member(:id, Shapes::ShapeRef.new(shape: ChatItemId, location_name: "Id"))
|
100
|
+
Item.add_member(:type, Shapes::ShapeRef.new(shape: ChatItemType, location_name: "Type"))
|
101
|
+
Item.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
102
|
+
Item.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, location_name: "DisplayName"))
|
103
|
+
Item.add_member(:participant_role, Shapes::ShapeRef.new(shape: ParticipantRole, location_name: "ParticipantRole"))
|
104
|
+
Item.struct_class = Types::Item
|
105
|
+
|
106
|
+
SendEventRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, required: true, location_name: "ContentType"))
|
107
|
+
SendEventRequest.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, location_name: "Content"))
|
108
|
+
SendEventRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
109
|
+
SendEventRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
110
|
+
SendEventRequest.struct_class = Types::SendEventRequest
|
111
|
+
|
112
|
+
SendEventResponse.add_member(:id, Shapes::ShapeRef.new(shape: ChatItemId, location_name: "Id"))
|
113
|
+
SendEventResponse.add_member(:absolute_time, Shapes::ShapeRef.new(shape: Instant, location_name: "AbsoluteTime"))
|
114
|
+
SendEventResponse.struct_class = Types::SendEventResponse
|
115
|
+
|
116
|
+
SendMessageRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, required: true, location_name: "ContentType"))
|
117
|
+
SendMessageRequest.add_member(:content, Shapes::ShapeRef.new(shape: ChatContent, required: true, location_name: "Content"))
|
118
|
+
SendMessageRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
119
|
+
SendMessageRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
120
|
+
SendMessageRequest.struct_class = Types::SendMessageRequest
|
121
|
+
|
122
|
+
SendMessageResponse.add_member(:id, Shapes::ShapeRef.new(shape: ChatItemId, location_name: "Id"))
|
123
|
+
SendMessageResponse.add_member(:absolute_time, Shapes::ShapeRef.new(shape: Instant, location_name: "AbsoluteTime"))
|
124
|
+
SendMessageResponse.struct_class = Types::SendMessageResponse
|
125
|
+
|
126
|
+
StartPosition.add_member(:id, Shapes::ShapeRef.new(shape: ChatItemId, location_name: "Id"))
|
127
|
+
StartPosition.add_member(:absolute_time, Shapes::ShapeRef.new(shape: Instant, location_name: "AbsoluteTime"))
|
128
|
+
StartPosition.add_member(:most_recent, Shapes::ShapeRef.new(shape: MostRecent, location_name: "MostRecent"))
|
129
|
+
StartPosition.struct_class = Types::StartPosition
|
130
|
+
|
131
|
+
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
132
|
+
ThrottlingException.struct_class = Types::ThrottlingException
|
133
|
+
|
134
|
+
Transcript.member = Shapes::ShapeRef.new(shape: Item)
|
135
|
+
|
136
|
+
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: Reason, required: true, location_name: "Message"))
|
137
|
+
ValidationException.struct_class = Types::ValidationException
|
138
|
+
|
139
|
+
Websocket.add_member(:url, Shapes::ShapeRef.new(shape: PreSignedConnectionUrl, location_name: "Url"))
|
140
|
+
Websocket.add_member(:connection_expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "ConnectionExpiry"))
|
141
|
+
Websocket.struct_class = Types::Websocket
|
142
|
+
|
143
|
+
|
144
|
+
# @api private
|
145
|
+
API = Seahorse::Model::Api.new.tap do |api|
|
146
|
+
|
147
|
+
api.version = "2018-09-07"
|
148
|
+
|
149
|
+
api.metadata = {
|
150
|
+
"apiVersion" => "2018-09-07",
|
151
|
+
"endpointPrefix" => "participant.connect",
|
152
|
+
"jsonVersion" => "1.1",
|
153
|
+
"protocol" => "rest-json",
|
154
|
+
"serviceAbbreviation" => "Amazon Connect Participant",
|
155
|
+
"serviceFullName" => "Amazon Connect Participant Service",
|
156
|
+
"serviceId" => "ConnectParticipant",
|
157
|
+
"signatureVersion" => "v4",
|
158
|
+
"signingName" => "execute-api",
|
159
|
+
"uid" => "connectparticipant-2018-09-07",
|
160
|
+
}
|
161
|
+
|
162
|
+
api.add_operation(:create_participant_connection, Seahorse::Model::Operation.new.tap do |o|
|
163
|
+
o.name = "CreateParticipantConnection"
|
164
|
+
o.http_method = "POST"
|
165
|
+
o.http_request_uri = "/participant/connection"
|
166
|
+
o.input = Shapes::ShapeRef.new(shape: CreateParticipantConnectionRequest)
|
167
|
+
o.output = Shapes::ShapeRef.new(shape: CreateParticipantConnectionResponse)
|
168
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
169
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
170
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
171
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
172
|
+
end)
|
173
|
+
|
174
|
+
api.add_operation(:disconnect_participant, Seahorse::Model::Operation.new.tap do |o|
|
175
|
+
o.name = "DisconnectParticipant"
|
176
|
+
o.http_method = "POST"
|
177
|
+
o.http_request_uri = "/participant/disconnect"
|
178
|
+
o.input = Shapes::ShapeRef.new(shape: DisconnectParticipantRequest)
|
179
|
+
o.output = Shapes::ShapeRef.new(shape: DisconnectParticipantResponse)
|
180
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
181
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
182
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
183
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
184
|
+
end)
|
185
|
+
|
186
|
+
api.add_operation(:get_transcript, Seahorse::Model::Operation.new.tap do |o|
|
187
|
+
o.name = "GetTranscript"
|
188
|
+
o.http_method = "POST"
|
189
|
+
o.http_request_uri = "/participant/transcript"
|
190
|
+
o.input = Shapes::ShapeRef.new(shape: GetTranscriptRequest)
|
191
|
+
o.output = Shapes::ShapeRef.new(shape: GetTranscriptResponse)
|
192
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
193
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
194
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
195
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
196
|
+
o[:pager] = Aws::Pager.new(
|
197
|
+
limit_key: "max_results",
|
198
|
+
tokens: {
|
199
|
+
"next_token" => "next_token"
|
200
|
+
}
|
201
|
+
)
|
202
|
+
end)
|
203
|
+
|
204
|
+
api.add_operation(:send_event, Seahorse::Model::Operation.new.tap do |o|
|
205
|
+
o.name = "SendEvent"
|
206
|
+
o.http_method = "POST"
|
207
|
+
o.http_request_uri = "/participant/event"
|
208
|
+
o.input = Shapes::ShapeRef.new(shape: SendEventRequest)
|
209
|
+
o.output = Shapes::ShapeRef.new(shape: SendEventResponse)
|
210
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
211
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
212
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
213
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
214
|
+
end)
|
215
|
+
|
216
|
+
api.add_operation(:send_message, Seahorse::Model::Operation.new.tap do |o|
|
217
|
+
o.name = "SendMessage"
|
218
|
+
o.http_method = "POST"
|
219
|
+
o.http_request_uri = "/participant/message"
|
220
|
+
o.input = Shapes::ShapeRef.new(shape: SendMessageRequest)
|
221
|
+
o.output = Shapes::ShapeRef.new(shape: SendMessageResponse)
|
222
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
223
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
224
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
225
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
226
|
+
end)
|
227
|
+
end
|
228
|
+
|
229
|
+
end
|
230
|
+
end
|
File without changes
|
@@ -0,0 +1,78 @@
|
|
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
|
+
module Aws::ConnectParticipant
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class AccessDeniedException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::ConnectParticipant::Types::AccessDeniedException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
class InternalServerException < ServiceError
|
30
|
+
|
31
|
+
# @param [Seahorse::Client::RequestContext] context
|
32
|
+
# @param [String] message
|
33
|
+
# @param [Aws::ConnectParticipant::Types::InternalServerException] data
|
34
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
35
|
+
super(context, message, data)
|
36
|
+
end
|
37
|
+
|
38
|
+
# @return [String]
|
39
|
+
def message
|
40
|
+
@message || @data[:message]
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
44
|
+
|
45
|
+
class ThrottlingException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::ConnectParticipant::Types::ThrottlingException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class ValidationException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::ConnectParticipant::Types::ValidationException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def message
|
72
|
+
@message || @data[:message]
|
73
|
+
end
|
74
|
+
|
75
|
+
end
|
76
|
+
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,23 @@
|
|
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
|
+
module Aws::ConnectParticipant
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,481 @@
|
|
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
|
+
module Aws::ConnectParticipant
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# You do not have sufficient access to perform this action.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] message
|
14
|
+
# @return [String]
|
15
|
+
#
|
16
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/AccessDeniedException AWS API Documentation
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
include Aws::Structure
|
21
|
+
end
|
22
|
+
|
23
|
+
# Connection credentials.
|
24
|
+
#
|
25
|
+
# @!attribute [rw] connection_token
|
26
|
+
# The connection token.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] expiry
|
30
|
+
# The expiration of the token.
|
31
|
+
#
|
32
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
33
|
+
# example, 2019-11-08T02:41:28.172Z.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ConnectionCredentials AWS API Documentation
|
37
|
+
#
|
38
|
+
class ConnectionCredentials < Struct.new(
|
39
|
+
:connection_token,
|
40
|
+
:expiry)
|
41
|
+
include Aws::Structure
|
42
|
+
end
|
43
|
+
|
44
|
+
# @note When making an API call, you may pass CreateParticipantConnectionRequest
|
45
|
+
# data as a hash:
|
46
|
+
#
|
47
|
+
# {
|
48
|
+
# type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
|
49
|
+
# participant_token: "ParticipantToken", # required
|
50
|
+
# }
|
51
|
+
#
|
52
|
+
# @!attribute [rw] type
|
53
|
+
# Type of connection information required.
|
54
|
+
# @return [Array<String>]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] participant_token
|
57
|
+
# Participant Token as obtained from [StartChatContact][1] API
|
58
|
+
# response.
|
59
|
+
#
|
60
|
+
#
|
61
|
+
#
|
62
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContactResponse.html
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnectionRequest AWS API Documentation
|
66
|
+
#
|
67
|
+
class CreateParticipantConnectionRequest < Struct.new(
|
68
|
+
:type,
|
69
|
+
:participant_token)
|
70
|
+
include Aws::Structure
|
71
|
+
end
|
72
|
+
|
73
|
+
# @!attribute [rw] websocket
|
74
|
+
# Creates the participant's websocket connection.
|
75
|
+
# @return [Types::Websocket]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] connection_credentials
|
78
|
+
# Creates the participant's connection credentials. The
|
79
|
+
# authentication token associated with the participant's connection.
|
80
|
+
# @return [Types::ConnectionCredentials]
|
81
|
+
#
|
82
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnectionResponse AWS API Documentation
|
83
|
+
#
|
84
|
+
class CreateParticipantConnectionResponse < Struct.new(
|
85
|
+
:websocket,
|
86
|
+
:connection_credentials)
|
87
|
+
include Aws::Structure
|
88
|
+
end
|
89
|
+
|
90
|
+
# @note When making an API call, you may pass DisconnectParticipantRequest
|
91
|
+
# data as a hash:
|
92
|
+
#
|
93
|
+
# {
|
94
|
+
# client_token: "ClientToken",
|
95
|
+
# connection_token: "ParticipantToken", # required
|
96
|
+
# }
|
97
|
+
#
|
98
|
+
# @!attribute [rw] client_token
|
99
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
100
|
+
# idempotency of the request.
|
101
|
+
#
|
102
|
+
# **A suitable default value is auto-generated.** You should normally
|
103
|
+
# not need to pass this option.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] connection_token
|
107
|
+
# The authentication token associated with the participant's
|
108
|
+
# connection.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipantRequest AWS API Documentation
|
112
|
+
#
|
113
|
+
class DisconnectParticipantRequest < Struct.new(
|
114
|
+
:client_token,
|
115
|
+
:connection_token)
|
116
|
+
include Aws::Structure
|
117
|
+
end
|
118
|
+
|
119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DisconnectParticipantResponse AWS API Documentation
|
120
|
+
#
|
121
|
+
class DisconnectParticipantResponse < Aws::EmptyStructure; end
|
122
|
+
|
123
|
+
# @note When making an API call, you may pass GetTranscriptRequest
|
124
|
+
# data as a hash:
|
125
|
+
#
|
126
|
+
# {
|
127
|
+
# contact_id: "ContactId",
|
128
|
+
# max_results: 1,
|
129
|
+
# next_token: "NextToken",
|
130
|
+
# scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
|
131
|
+
# sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
|
132
|
+
# start_position: {
|
133
|
+
# id: "ChatItemId",
|
134
|
+
# absolute_time: "Instant",
|
135
|
+
# most_recent: 1,
|
136
|
+
# },
|
137
|
+
# connection_token: "ParticipantToken", # required
|
138
|
+
# }
|
139
|
+
#
|
140
|
+
# @!attribute [rw] contact_id
|
141
|
+
# The contactId from the current contact chain for which transcript is
|
142
|
+
# needed.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] max_results
|
146
|
+
# The maximum number of results to return in the page. Default: 10.
|
147
|
+
# @return [Integer]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] next_token
|
150
|
+
# The pagination token. Use the value returned previously in the next
|
151
|
+
# subsequent request to retrieve the next set of results.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] scan_direction
|
155
|
+
# The direction from StartPosition from which to retrieve message.
|
156
|
+
# Default: BACKWARD when no StartPosition is provided, FORWARD with
|
157
|
+
# StartPosition.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] sort_order
|
161
|
+
# The sort order for the records. Default: DESCENDING.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] start_position
|
165
|
+
# A filtering option for where to start.
|
166
|
+
# @return [Types::StartPosition]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] connection_token
|
169
|
+
# The authentication token associated with the participant's
|
170
|
+
# connection.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscriptRequest AWS API Documentation
|
174
|
+
#
|
175
|
+
class GetTranscriptRequest < Struct.new(
|
176
|
+
:contact_id,
|
177
|
+
:max_results,
|
178
|
+
:next_token,
|
179
|
+
:scan_direction,
|
180
|
+
:sort_order,
|
181
|
+
:start_position,
|
182
|
+
:connection_token)
|
183
|
+
include Aws::Structure
|
184
|
+
end
|
185
|
+
|
186
|
+
# @!attribute [rw] initial_contact_id
|
187
|
+
# The initial contact ID for the contact.
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] transcript
|
191
|
+
# The list of messages in the session.
|
192
|
+
# @return [Array<Types::Item>]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] next_token
|
195
|
+
# The pagination token. Use the value returned previously in the next
|
196
|
+
# subsequent request to retrieve the next set of results.
|
197
|
+
# @return [String]
|
198
|
+
#
|
199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscriptResponse AWS API Documentation
|
200
|
+
#
|
201
|
+
class GetTranscriptResponse < Struct.new(
|
202
|
+
:initial_contact_id,
|
203
|
+
:transcript,
|
204
|
+
:next_token)
|
205
|
+
include Aws::Structure
|
206
|
+
end
|
207
|
+
|
208
|
+
# This exception occurs when there is an internal failure in the Amazon
|
209
|
+
# Connect service.
|
210
|
+
#
|
211
|
+
# @!attribute [rw] message
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/InternalServerException AWS API Documentation
|
215
|
+
#
|
216
|
+
class InternalServerException < Struct.new(
|
217
|
+
:message)
|
218
|
+
include Aws::Structure
|
219
|
+
end
|
220
|
+
|
221
|
+
# An item - message or event - that has been sent.
|
222
|
+
#
|
223
|
+
# @!attribute [rw] absolute_time
|
224
|
+
# The time when the message or event was sent.
|
225
|
+
#
|
226
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
227
|
+
# example, 2019-11-08T02:41:28.172Z.
|
228
|
+
# @return [String]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] content
|
231
|
+
# The content of the message or event.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] content_type
|
235
|
+
# The type of content of the item.
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] id
|
239
|
+
# The ID of the item.
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] type
|
243
|
+
# Type of the item: message or event.
|
244
|
+
# @return [String]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] participant_id
|
247
|
+
# The ID of the sender in the session.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] display_name
|
251
|
+
# The chat display name of the sender.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] participant_role
|
255
|
+
# The role of the sender. For example, is it a customer, agent, or
|
256
|
+
# system.
|
257
|
+
# @return [String]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Item AWS API Documentation
|
260
|
+
#
|
261
|
+
class Item < Struct.new(
|
262
|
+
:absolute_time,
|
263
|
+
:content,
|
264
|
+
:content_type,
|
265
|
+
:id,
|
266
|
+
:type,
|
267
|
+
:participant_id,
|
268
|
+
:display_name,
|
269
|
+
:participant_role)
|
270
|
+
include Aws::Structure
|
271
|
+
end
|
272
|
+
|
273
|
+
# @note When making an API call, you may pass SendEventRequest
|
274
|
+
# data as a hash:
|
275
|
+
#
|
276
|
+
# {
|
277
|
+
# content_type: "ChatContentType", # required
|
278
|
+
# content: "ChatContent",
|
279
|
+
# client_token: "ClientToken",
|
280
|
+
# connection_token: "ParticipantToken", # required
|
281
|
+
# }
|
282
|
+
#
|
283
|
+
# @!attribute [rw] content_type
|
284
|
+
# The content type of the request. Supported types are:
|
285
|
+
#
|
286
|
+
# * application/vnd.amazonaws.connect.event.typing
|
287
|
+
#
|
288
|
+
# * application/vnd.amazonaws.connect.event.connection.acknowledged
|
289
|
+
# @return [String]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] content
|
292
|
+
# The content of the event to be sent (for example, message text).
|
293
|
+
# This is not yet supported.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] client_token
|
297
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
298
|
+
# idempotency of the request.
|
299
|
+
#
|
300
|
+
# **A suitable default value is auto-generated.** You should normally
|
301
|
+
# not need to pass this option.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @!attribute [rw] connection_token
|
305
|
+
# The authentication token associated with the participant's
|
306
|
+
# connection.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEventRequest AWS API Documentation
|
310
|
+
#
|
311
|
+
class SendEventRequest < Struct.new(
|
312
|
+
:content_type,
|
313
|
+
:content,
|
314
|
+
:client_token,
|
315
|
+
:connection_token)
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# @!attribute [rw] id
|
320
|
+
# The ID of the response.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] absolute_time
|
324
|
+
# The time when the event was sent.
|
325
|
+
#
|
326
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
327
|
+
# example, 2019-11-08T02:41:28.172Z.
|
328
|
+
# @return [String]
|
329
|
+
#
|
330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendEventResponse AWS API Documentation
|
331
|
+
#
|
332
|
+
class SendEventResponse < Struct.new(
|
333
|
+
:id,
|
334
|
+
:absolute_time)
|
335
|
+
include Aws::Structure
|
336
|
+
end
|
337
|
+
|
338
|
+
# @note When making an API call, you may pass SendMessageRequest
|
339
|
+
# data as a hash:
|
340
|
+
#
|
341
|
+
# {
|
342
|
+
# content_type: "ChatContentType", # required
|
343
|
+
# content: "ChatContent", # required
|
344
|
+
# client_token: "ClientToken",
|
345
|
+
# connection_token: "ParticipantToken", # required
|
346
|
+
# }
|
347
|
+
#
|
348
|
+
# @!attribute [rw] content_type
|
349
|
+
# The type of the content. Supported types are text/plain.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] content
|
353
|
+
# The content of the message.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] client_token
|
357
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
358
|
+
# idempotency of the request.
|
359
|
+
#
|
360
|
+
# **A suitable default value is auto-generated.** You should normally
|
361
|
+
# not need to pass this option.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] connection_token
|
365
|
+
# The authentication token associated with the connection.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessageRequest AWS API Documentation
|
369
|
+
#
|
370
|
+
class SendMessageRequest < Struct.new(
|
371
|
+
:content_type,
|
372
|
+
:content,
|
373
|
+
:client_token,
|
374
|
+
:connection_token)
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
378
|
+
# @!attribute [rw] id
|
379
|
+
# The ID of the message.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] absolute_time
|
383
|
+
# The time when the message was sent.
|
384
|
+
#
|
385
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
386
|
+
# example, 2019-11-08T02:41:28.172Z.
|
387
|
+
# @return [String]
|
388
|
+
#
|
389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/SendMessageResponse AWS API Documentation
|
390
|
+
#
|
391
|
+
class SendMessageResponse < Struct.new(
|
392
|
+
:id,
|
393
|
+
:absolute_time)
|
394
|
+
include Aws::Structure
|
395
|
+
end
|
396
|
+
|
397
|
+
# A filtering option for where to start. For example, if you sent 100
|
398
|
+
# messages, start with message 50.
|
399
|
+
#
|
400
|
+
# @note When making an API call, you may pass StartPosition
|
401
|
+
# data as a hash:
|
402
|
+
#
|
403
|
+
# {
|
404
|
+
# id: "ChatItemId",
|
405
|
+
# absolute_time: "Instant",
|
406
|
+
# most_recent: 1,
|
407
|
+
# }
|
408
|
+
#
|
409
|
+
# @!attribute [rw] id
|
410
|
+
# The ID of the message or event where to start.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] absolute_time
|
414
|
+
# The time in ISO format where to start.
|
415
|
+
#
|
416
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
417
|
+
# example, 2019-11-08T02:41:28.172Z.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] most_recent
|
421
|
+
# The start position of the most recent message where you want to
|
422
|
+
# start.
|
423
|
+
# @return [Integer]
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartPosition AWS API Documentation
|
426
|
+
#
|
427
|
+
class StartPosition < Struct.new(
|
428
|
+
:id,
|
429
|
+
:absolute_time,
|
430
|
+
:most_recent)
|
431
|
+
include Aws::Structure
|
432
|
+
end
|
433
|
+
|
434
|
+
# The request was denied due to request throttling.
|
435
|
+
#
|
436
|
+
# @!attribute [rw] message
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ThrottlingException AWS API Documentation
|
440
|
+
#
|
441
|
+
class ThrottlingException < Struct.new(
|
442
|
+
:message)
|
443
|
+
include Aws::Structure
|
444
|
+
end
|
445
|
+
|
446
|
+
# The input fails to satisfy the constraints specified by Amazon
|
447
|
+
# Connect.
|
448
|
+
#
|
449
|
+
# @!attribute [rw] message
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ValidationException AWS API Documentation
|
453
|
+
#
|
454
|
+
class ValidationException < Struct.new(
|
455
|
+
:message)
|
456
|
+
include Aws::Structure
|
457
|
+
end
|
458
|
+
|
459
|
+
# The websocket for the participant's connection.
|
460
|
+
#
|
461
|
+
# @!attribute [rw] url
|
462
|
+
# The URL of the websocket.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] connection_expiry
|
466
|
+
# The URL expiration timestamp in ISO date format.
|
467
|
+
#
|
468
|
+
# It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
|
469
|
+
# example, 2019-11-08T02:41:28.172Z.
|
470
|
+
# @return [String]
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Websocket AWS API Documentation
|
473
|
+
#
|
474
|
+
class Websocket < Struct.new(
|
475
|
+
:url,
|
476
|
+
:connection_expiry)
|
477
|
+
include Aws::Structure
|
478
|
+
end
|
479
|
+
|
480
|
+
end
|
481
|
+
end
|