aws-sdk-pinpointsmsvoicev2 1.11.0 → 1.13.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/plugins/endpoints.rb +4 -2
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- data/sig/client.rbs +1318 -0
- data/sig/errors.rbs +47 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +1556 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
data/sig/client.rbs
ADDED
@@ -0,0 +1,1318 @@
|
|
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 PinpointSMSVoiceV2
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/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
|
+
?simple_json: bool,
|
52
|
+
?stub_responses: untyped,
|
53
|
+
?token_provider: untyped,
|
54
|
+
?use_dualstack_endpoint: bool,
|
55
|
+
?use_fips_endpoint: bool,
|
56
|
+
?validate_params: bool,
|
57
|
+
?endpoint_provider: untyped,
|
58
|
+
?http_proxy: String,
|
59
|
+
?http_open_timeout: (Float | Integer),
|
60
|
+
?http_read_timeout: (Float | Integer),
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
64
|
+
?http_wire_trace: bool,
|
65
|
+
?ssl_verify_peer: bool,
|
66
|
+
?ssl_ca_bundle: String,
|
67
|
+
?ssl_ca_directory: String,
|
68
|
+
?ssl_ca_store: String,
|
69
|
+
?on_chunk_received: Proc,
|
70
|
+
?on_chunk_sent: Proc,
|
71
|
+
?raise_response_errors: bool
|
72
|
+
) -> instance
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
74
|
+
|
75
|
+
|
76
|
+
interface _AssociateOriginationIdentityResponseSuccess
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AssociateOriginationIdentityResult]
|
78
|
+
def pool_arn: () -> ::String
|
79
|
+
def pool_id: () -> ::String
|
80
|
+
def origination_identity_arn: () -> ::String
|
81
|
+
def origination_identity: () -> ::String
|
82
|
+
def iso_country_code: () -> ::String
|
83
|
+
end
|
84
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#associate_origination_identity-instance_method
|
85
|
+
def associate_origination_identity: (
|
86
|
+
pool_id: ::String,
|
87
|
+
origination_identity: ::String,
|
88
|
+
iso_country_code: ::String,
|
89
|
+
?client_token: ::String
|
90
|
+
) -> _AssociateOriginationIdentityResponseSuccess
|
91
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateOriginationIdentityResponseSuccess
|
92
|
+
|
93
|
+
interface _CreateConfigurationSetResponseSuccess
|
94
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateConfigurationSetResult]
|
95
|
+
def configuration_set_arn: () -> ::String
|
96
|
+
def configuration_set_name: () -> ::String
|
97
|
+
def tags: () -> ::Array[Types::Tag]
|
98
|
+
def created_timestamp: () -> ::Time
|
99
|
+
end
|
100
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_configuration_set-instance_method
|
101
|
+
def create_configuration_set: (
|
102
|
+
configuration_set_name: ::String,
|
103
|
+
?tags: Array[
|
104
|
+
{
|
105
|
+
key: ::String,
|
106
|
+
value: ::String
|
107
|
+
},
|
108
|
+
],
|
109
|
+
?client_token: ::String
|
110
|
+
) -> _CreateConfigurationSetResponseSuccess
|
111
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateConfigurationSetResponseSuccess
|
112
|
+
|
113
|
+
interface _CreateEventDestinationResponseSuccess
|
114
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateEventDestinationResult]
|
115
|
+
def configuration_set_arn: () -> ::String
|
116
|
+
def configuration_set_name: () -> ::String
|
117
|
+
def event_destination: () -> Types::EventDestination
|
118
|
+
end
|
119
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_event_destination-instance_method
|
120
|
+
def create_event_destination: (
|
121
|
+
configuration_set_name: ::String,
|
122
|
+
event_destination_name: ::String,
|
123
|
+
matching_event_types: Array[("ALL" | "TEXT_ALL" | "TEXT_SENT" | "TEXT_PENDING" | "TEXT_QUEUED" | "TEXT_SUCCESSFUL" | "TEXT_DELIVERED" | "TEXT_INVALID" | "TEXT_INVALID_MESSAGE" | "TEXT_UNREACHABLE" | "TEXT_CARRIER_UNREACHABLE" | "TEXT_BLOCKED" | "TEXT_CARRIER_BLOCKED" | "TEXT_SPAM" | "TEXT_UNKNOWN" | "TEXT_TTL_EXPIRED" | "VOICE_ALL" | "VOICE_INITIATED" | "VOICE_RINGING" | "VOICE_ANSWERED" | "VOICE_COMPLETED" | "VOICE_BUSY" | "VOICE_NO_ANSWER" | "VOICE_FAILED" | "VOICE_TTL_EXPIRED")],
|
124
|
+
?cloud_watch_logs_destination: {
|
125
|
+
iam_role_arn: ::String,
|
126
|
+
log_group_arn: ::String
|
127
|
+
},
|
128
|
+
?kinesis_firehose_destination: {
|
129
|
+
iam_role_arn: ::String,
|
130
|
+
delivery_stream_arn: ::String
|
131
|
+
},
|
132
|
+
?sns_destination: {
|
133
|
+
topic_arn: ::String
|
134
|
+
},
|
135
|
+
?client_token: ::String
|
136
|
+
) -> _CreateEventDestinationResponseSuccess
|
137
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateEventDestinationResponseSuccess
|
138
|
+
|
139
|
+
interface _CreateOptOutListResponseSuccess
|
140
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateOptOutListResult]
|
141
|
+
def opt_out_list_arn: () -> ::String
|
142
|
+
def opt_out_list_name: () -> ::String
|
143
|
+
def tags: () -> ::Array[Types::Tag]
|
144
|
+
def created_timestamp: () -> ::Time
|
145
|
+
end
|
146
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_opt_out_list-instance_method
|
147
|
+
def create_opt_out_list: (
|
148
|
+
opt_out_list_name: ::String,
|
149
|
+
?tags: Array[
|
150
|
+
{
|
151
|
+
key: ::String,
|
152
|
+
value: ::String
|
153
|
+
},
|
154
|
+
],
|
155
|
+
?client_token: ::String
|
156
|
+
) -> _CreateOptOutListResponseSuccess
|
157
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateOptOutListResponseSuccess
|
158
|
+
|
159
|
+
interface _CreatePoolResponseSuccess
|
160
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreatePoolResult]
|
161
|
+
def pool_arn: () -> ::String
|
162
|
+
def pool_id: () -> ::String
|
163
|
+
def status: () -> ("CREATING" | "ACTIVE" | "DELETING")
|
164
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
165
|
+
def two_way_enabled: () -> bool
|
166
|
+
def two_way_channel_arn: () -> ::String
|
167
|
+
def two_way_channel_role: () -> ::String
|
168
|
+
def self_managed_opt_outs_enabled: () -> bool
|
169
|
+
def opt_out_list_name: () -> ::String
|
170
|
+
def shared_routes_enabled: () -> bool
|
171
|
+
def deletion_protection_enabled: () -> bool
|
172
|
+
def tags: () -> ::Array[Types::Tag]
|
173
|
+
def created_timestamp: () -> ::Time
|
174
|
+
end
|
175
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_pool-instance_method
|
176
|
+
def create_pool: (
|
177
|
+
origination_identity: ::String,
|
178
|
+
iso_country_code: ::String,
|
179
|
+
message_type: ("TRANSACTIONAL" | "PROMOTIONAL"),
|
180
|
+
?deletion_protection_enabled: bool,
|
181
|
+
?tags: Array[
|
182
|
+
{
|
183
|
+
key: ::String,
|
184
|
+
value: ::String
|
185
|
+
},
|
186
|
+
],
|
187
|
+
?client_token: ::String
|
188
|
+
) -> _CreatePoolResponseSuccess
|
189
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePoolResponseSuccess
|
190
|
+
|
191
|
+
interface _CreateRegistrationResponseSuccess
|
192
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRegistrationResult]
|
193
|
+
def registration_arn: () -> ::String
|
194
|
+
def registration_id: () -> ::String
|
195
|
+
def registration_type: () -> ::String
|
196
|
+
def registration_status: () -> ("CREATED" | "SUBMITTED" | "REVIEWING" | "PROVISIONING" | "COMPLETE" | "REQUIRES_UPDATES" | "CLOSED" | "DELETED")
|
197
|
+
def current_version_number: () -> ::Integer
|
198
|
+
def additional_attributes: () -> ::Hash[::String, ::String]
|
199
|
+
def tags: () -> ::Array[Types::Tag]
|
200
|
+
def created_timestamp: () -> ::Time
|
201
|
+
end
|
202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_registration-instance_method
|
203
|
+
def create_registration: (
|
204
|
+
registration_type: ::String,
|
205
|
+
?tags: Array[
|
206
|
+
{
|
207
|
+
key: ::String,
|
208
|
+
value: ::String
|
209
|
+
},
|
210
|
+
],
|
211
|
+
?client_token: ::String
|
212
|
+
) -> _CreateRegistrationResponseSuccess
|
213
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRegistrationResponseSuccess
|
214
|
+
|
215
|
+
interface _CreateRegistrationAssociationResponseSuccess
|
216
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRegistrationAssociationResult]
|
217
|
+
def registration_arn: () -> ::String
|
218
|
+
def registration_id: () -> ::String
|
219
|
+
def registration_type: () -> ::String
|
220
|
+
def resource_arn: () -> ::String
|
221
|
+
def resource_id: () -> ::String
|
222
|
+
def resource_type: () -> ::String
|
223
|
+
def iso_country_code: () -> ::String
|
224
|
+
def phone_number: () -> ::String
|
225
|
+
end
|
226
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_registration_association-instance_method
|
227
|
+
def create_registration_association: (
|
228
|
+
registration_id: ::String,
|
229
|
+
resource_id: ::String
|
230
|
+
) -> _CreateRegistrationAssociationResponseSuccess
|
231
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRegistrationAssociationResponseSuccess
|
232
|
+
|
233
|
+
interface _CreateRegistrationAttachmentResponseSuccess
|
234
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRegistrationAttachmentResult]
|
235
|
+
def registration_attachment_arn: () -> ::String
|
236
|
+
def registration_attachment_id: () -> ::String
|
237
|
+
def attachment_status: () -> ("UPLOAD_IN_PROGRESS" | "UPLOAD_COMPLETE" | "UPLOAD_FAILED" | "DELETED")
|
238
|
+
def tags: () -> ::Array[Types::Tag]
|
239
|
+
def created_timestamp: () -> ::Time
|
240
|
+
end
|
241
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_registration_attachment-instance_method
|
242
|
+
def create_registration_attachment: (
|
243
|
+
?attachment_body: ::String,
|
244
|
+
?attachment_url: ::String,
|
245
|
+
?tags: Array[
|
246
|
+
{
|
247
|
+
key: ::String,
|
248
|
+
value: ::String
|
249
|
+
},
|
250
|
+
],
|
251
|
+
?client_token: ::String
|
252
|
+
) -> _CreateRegistrationAttachmentResponseSuccess
|
253
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRegistrationAttachmentResponseSuccess
|
254
|
+
|
255
|
+
interface _CreateRegistrationVersionResponseSuccess
|
256
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRegistrationVersionResult]
|
257
|
+
def registration_arn: () -> ::String
|
258
|
+
def registration_id: () -> ::String
|
259
|
+
def version_number: () -> ::Integer
|
260
|
+
def registration_version_status: () -> ("DRAFT" | "SUBMITTED" | "REVIEWING" | "APPROVED" | "DISCARDED" | "DENIED" | "REVOKED" | "ARCHIVED")
|
261
|
+
def registration_version_status_history: () -> Types::RegistrationVersionStatusHistory
|
262
|
+
end
|
263
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_registration_version-instance_method
|
264
|
+
def create_registration_version: (
|
265
|
+
registration_id: ::String
|
266
|
+
) -> _CreateRegistrationVersionResponseSuccess
|
267
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRegistrationVersionResponseSuccess
|
268
|
+
|
269
|
+
interface _CreateVerifiedDestinationNumberResponseSuccess
|
270
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateVerifiedDestinationNumberResult]
|
271
|
+
def verified_destination_number_arn: () -> ::String
|
272
|
+
def verified_destination_number_id: () -> ::String
|
273
|
+
def destination_phone_number: () -> ::String
|
274
|
+
def status: () -> ("PENDING" | "VERIFIED")
|
275
|
+
def tags: () -> ::Array[Types::Tag]
|
276
|
+
def created_timestamp: () -> ::Time
|
277
|
+
end
|
278
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#create_verified_destination_number-instance_method
|
279
|
+
def create_verified_destination_number: (
|
280
|
+
destination_phone_number: ::String,
|
281
|
+
?tags: Array[
|
282
|
+
{
|
283
|
+
key: ::String,
|
284
|
+
value: ::String
|
285
|
+
},
|
286
|
+
],
|
287
|
+
?client_token: ::String
|
288
|
+
) -> _CreateVerifiedDestinationNumberResponseSuccess
|
289
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateVerifiedDestinationNumberResponseSuccess
|
290
|
+
|
291
|
+
interface _DeleteConfigurationSetResponseSuccess
|
292
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteConfigurationSetResult]
|
293
|
+
def configuration_set_arn: () -> ::String
|
294
|
+
def configuration_set_name: () -> ::String
|
295
|
+
def event_destinations: () -> ::Array[Types::EventDestination]
|
296
|
+
def default_message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
297
|
+
def default_sender_id: () -> ::String
|
298
|
+
def created_timestamp: () -> ::Time
|
299
|
+
end
|
300
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_configuration_set-instance_method
|
301
|
+
def delete_configuration_set: (
|
302
|
+
configuration_set_name: ::String
|
303
|
+
) -> _DeleteConfigurationSetResponseSuccess
|
304
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteConfigurationSetResponseSuccess
|
305
|
+
|
306
|
+
interface _DeleteDefaultMessageTypeResponseSuccess
|
307
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDefaultMessageTypeResult]
|
308
|
+
def configuration_set_arn: () -> ::String
|
309
|
+
def configuration_set_name: () -> ::String
|
310
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
311
|
+
end
|
312
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_default_message_type-instance_method
|
313
|
+
def delete_default_message_type: (
|
314
|
+
configuration_set_name: ::String
|
315
|
+
) -> _DeleteDefaultMessageTypeResponseSuccess
|
316
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDefaultMessageTypeResponseSuccess
|
317
|
+
|
318
|
+
interface _DeleteDefaultSenderIdResponseSuccess
|
319
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDefaultSenderIdResult]
|
320
|
+
def configuration_set_arn: () -> ::String
|
321
|
+
def configuration_set_name: () -> ::String
|
322
|
+
def sender_id: () -> ::String
|
323
|
+
end
|
324
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_default_sender_id-instance_method
|
325
|
+
def delete_default_sender_id: (
|
326
|
+
configuration_set_name: ::String
|
327
|
+
) -> _DeleteDefaultSenderIdResponseSuccess
|
328
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDefaultSenderIdResponseSuccess
|
329
|
+
|
330
|
+
interface _DeleteEventDestinationResponseSuccess
|
331
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteEventDestinationResult]
|
332
|
+
def configuration_set_arn: () -> ::String
|
333
|
+
def configuration_set_name: () -> ::String
|
334
|
+
def event_destination: () -> Types::EventDestination
|
335
|
+
end
|
336
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_event_destination-instance_method
|
337
|
+
def delete_event_destination: (
|
338
|
+
configuration_set_name: ::String,
|
339
|
+
event_destination_name: ::String
|
340
|
+
) -> _DeleteEventDestinationResponseSuccess
|
341
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteEventDestinationResponseSuccess
|
342
|
+
|
343
|
+
interface _DeleteKeywordResponseSuccess
|
344
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteKeywordResult]
|
345
|
+
def origination_identity_arn: () -> ::String
|
346
|
+
def origination_identity: () -> ::String
|
347
|
+
def keyword: () -> ::String
|
348
|
+
def keyword_message: () -> ::String
|
349
|
+
def keyword_action: () -> ("AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN")
|
350
|
+
end
|
351
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_keyword-instance_method
|
352
|
+
def delete_keyword: (
|
353
|
+
origination_identity: ::String,
|
354
|
+
keyword: ::String
|
355
|
+
) -> _DeleteKeywordResponseSuccess
|
356
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKeywordResponseSuccess
|
357
|
+
|
358
|
+
interface _DeleteOptOutListResponseSuccess
|
359
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteOptOutListResult]
|
360
|
+
def opt_out_list_arn: () -> ::String
|
361
|
+
def opt_out_list_name: () -> ::String
|
362
|
+
def created_timestamp: () -> ::Time
|
363
|
+
end
|
364
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_opt_out_list-instance_method
|
365
|
+
def delete_opt_out_list: (
|
366
|
+
opt_out_list_name: ::String
|
367
|
+
) -> _DeleteOptOutListResponseSuccess
|
368
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteOptOutListResponseSuccess
|
369
|
+
|
370
|
+
interface _DeleteOptedOutNumberResponseSuccess
|
371
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteOptedOutNumberResult]
|
372
|
+
def opt_out_list_arn: () -> ::String
|
373
|
+
def opt_out_list_name: () -> ::String
|
374
|
+
def opted_out_number: () -> ::String
|
375
|
+
def opted_out_timestamp: () -> ::Time
|
376
|
+
def end_user_opted_out: () -> bool
|
377
|
+
end
|
378
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_opted_out_number-instance_method
|
379
|
+
def delete_opted_out_number: (
|
380
|
+
opt_out_list_name: ::String,
|
381
|
+
opted_out_number: ::String
|
382
|
+
) -> _DeleteOptedOutNumberResponseSuccess
|
383
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteOptedOutNumberResponseSuccess
|
384
|
+
|
385
|
+
interface _DeletePoolResponseSuccess
|
386
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeletePoolResult]
|
387
|
+
def pool_arn: () -> ::String
|
388
|
+
def pool_id: () -> ::String
|
389
|
+
def status: () -> ("CREATING" | "ACTIVE" | "DELETING")
|
390
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
391
|
+
def two_way_enabled: () -> bool
|
392
|
+
def two_way_channel_arn: () -> ::String
|
393
|
+
def two_way_channel_role: () -> ::String
|
394
|
+
def self_managed_opt_outs_enabled: () -> bool
|
395
|
+
def opt_out_list_name: () -> ::String
|
396
|
+
def shared_routes_enabled: () -> bool
|
397
|
+
def created_timestamp: () -> ::Time
|
398
|
+
end
|
399
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_pool-instance_method
|
400
|
+
def delete_pool: (
|
401
|
+
pool_id: ::String
|
402
|
+
) -> _DeletePoolResponseSuccess
|
403
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeletePoolResponseSuccess
|
404
|
+
|
405
|
+
interface _DeleteRegistrationResponseSuccess
|
406
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRegistrationResult]
|
407
|
+
def registration_arn: () -> ::String
|
408
|
+
def registration_id: () -> ::String
|
409
|
+
def registration_type: () -> ::String
|
410
|
+
def registration_status: () -> ("CREATED" | "SUBMITTED" | "REVIEWING" | "PROVISIONING" | "COMPLETE" | "REQUIRES_UPDATES" | "CLOSED" | "DELETED")
|
411
|
+
def current_version_number: () -> ::Integer
|
412
|
+
def approved_version_number: () -> ::Integer
|
413
|
+
def latest_denied_version_number: () -> ::Integer
|
414
|
+
def additional_attributes: () -> ::Hash[::String, ::String]
|
415
|
+
def created_timestamp: () -> ::Time
|
416
|
+
end
|
417
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_registration-instance_method
|
418
|
+
def delete_registration: (
|
419
|
+
registration_id: ::String
|
420
|
+
) -> _DeleteRegistrationResponseSuccess
|
421
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRegistrationResponseSuccess
|
422
|
+
|
423
|
+
interface _DeleteRegistrationAttachmentResponseSuccess
|
424
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRegistrationAttachmentResult]
|
425
|
+
def registration_attachment_arn: () -> ::String
|
426
|
+
def registration_attachment_id: () -> ::String
|
427
|
+
def attachment_status: () -> ("UPLOAD_IN_PROGRESS" | "UPLOAD_COMPLETE" | "UPLOAD_FAILED" | "DELETED")
|
428
|
+
def attachment_upload_error_reason: () -> ("INTERNAL_ERROR")
|
429
|
+
def created_timestamp: () -> ::Time
|
430
|
+
end
|
431
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_registration_attachment-instance_method
|
432
|
+
def delete_registration_attachment: (
|
433
|
+
registration_attachment_id: ::String
|
434
|
+
) -> _DeleteRegistrationAttachmentResponseSuccess
|
435
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRegistrationAttachmentResponseSuccess
|
436
|
+
|
437
|
+
interface _DeleteRegistrationFieldValueResponseSuccess
|
438
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteRegistrationFieldValueResult]
|
439
|
+
def registration_arn: () -> ::String
|
440
|
+
def registration_id: () -> ::String
|
441
|
+
def version_number: () -> ::Integer
|
442
|
+
def field_path: () -> ::String
|
443
|
+
def select_choices: () -> ::Array[::String]
|
444
|
+
def text_value: () -> ::String
|
445
|
+
def registration_attachment_id: () -> ::String
|
446
|
+
end
|
447
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_registration_field_value-instance_method
|
448
|
+
def delete_registration_field_value: (
|
449
|
+
registration_id: ::String,
|
450
|
+
field_path: ::String
|
451
|
+
) -> _DeleteRegistrationFieldValueResponseSuccess
|
452
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteRegistrationFieldValueResponseSuccess
|
453
|
+
|
454
|
+
interface _DeleteTextMessageSpendLimitOverrideResponseSuccess
|
455
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteTextMessageSpendLimitOverrideResult]
|
456
|
+
def monthly_limit: () -> ::Integer
|
457
|
+
end
|
458
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_text_message_spend_limit_override-instance_method
|
459
|
+
def delete_text_message_spend_limit_override: (
|
460
|
+
) -> _DeleteTextMessageSpendLimitOverrideResponseSuccess
|
461
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteTextMessageSpendLimitOverrideResponseSuccess
|
462
|
+
|
463
|
+
interface _DeleteVerifiedDestinationNumberResponseSuccess
|
464
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteVerifiedDestinationNumberResult]
|
465
|
+
def verified_destination_number_arn: () -> ::String
|
466
|
+
def verified_destination_number_id: () -> ::String
|
467
|
+
def destination_phone_number: () -> ::String
|
468
|
+
def created_timestamp: () -> ::Time
|
469
|
+
end
|
470
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_verified_destination_number-instance_method
|
471
|
+
def delete_verified_destination_number: (
|
472
|
+
verified_destination_number_id: ::String
|
473
|
+
) -> _DeleteVerifiedDestinationNumberResponseSuccess
|
474
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteVerifiedDestinationNumberResponseSuccess
|
475
|
+
|
476
|
+
interface _DeleteVoiceMessageSpendLimitOverrideResponseSuccess
|
477
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteVoiceMessageSpendLimitOverrideResult]
|
478
|
+
def monthly_limit: () -> ::Integer
|
479
|
+
end
|
480
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#delete_voice_message_spend_limit_override-instance_method
|
481
|
+
def delete_voice_message_spend_limit_override: (
|
482
|
+
) -> _DeleteVoiceMessageSpendLimitOverrideResponseSuccess
|
483
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteVoiceMessageSpendLimitOverrideResponseSuccess
|
484
|
+
|
485
|
+
interface _DescribeAccountAttributesResponseSuccess
|
486
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAccountAttributesResult]
|
487
|
+
def account_attributes: () -> ::Array[Types::AccountAttribute]
|
488
|
+
def next_token: () -> ::String
|
489
|
+
end
|
490
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_account_attributes-instance_method
|
491
|
+
def describe_account_attributes: (
|
492
|
+
?next_token: ::String,
|
493
|
+
?max_results: ::Integer
|
494
|
+
) -> _DescribeAccountAttributesResponseSuccess
|
495
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeAccountAttributesResponseSuccess
|
496
|
+
|
497
|
+
interface _DescribeAccountLimitsResponseSuccess
|
498
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAccountLimitsResult]
|
499
|
+
def account_limits: () -> ::Array[Types::AccountLimit]
|
500
|
+
def next_token: () -> ::String
|
501
|
+
end
|
502
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_account_limits-instance_method
|
503
|
+
def describe_account_limits: (
|
504
|
+
?next_token: ::String,
|
505
|
+
?max_results: ::Integer
|
506
|
+
) -> _DescribeAccountLimitsResponseSuccess
|
507
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeAccountLimitsResponseSuccess
|
508
|
+
|
509
|
+
interface _DescribeConfigurationSetsResponseSuccess
|
510
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeConfigurationSetsResult]
|
511
|
+
def configuration_sets: () -> ::Array[Types::ConfigurationSetInformation]
|
512
|
+
def next_token: () -> ::String
|
513
|
+
end
|
514
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_configuration_sets-instance_method
|
515
|
+
def describe_configuration_sets: (
|
516
|
+
?configuration_set_names: Array[::String],
|
517
|
+
?filters: Array[
|
518
|
+
{
|
519
|
+
name: ("event-destination-name" | "matching-event-types" | "default-message-type" | "default-sender-id"),
|
520
|
+
values: Array[::String]
|
521
|
+
},
|
522
|
+
],
|
523
|
+
?next_token: ::String,
|
524
|
+
?max_results: ::Integer
|
525
|
+
) -> _DescribeConfigurationSetsResponseSuccess
|
526
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeConfigurationSetsResponseSuccess
|
527
|
+
|
528
|
+
interface _DescribeKeywordsResponseSuccess
|
529
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeKeywordsResult]
|
530
|
+
def origination_identity_arn: () -> ::String
|
531
|
+
def origination_identity: () -> ::String
|
532
|
+
def keywords: () -> ::Array[Types::KeywordInformation]
|
533
|
+
def next_token: () -> ::String
|
534
|
+
end
|
535
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_keywords-instance_method
|
536
|
+
def describe_keywords: (
|
537
|
+
origination_identity: ::String,
|
538
|
+
?keywords: Array[::String],
|
539
|
+
?filters: Array[
|
540
|
+
{
|
541
|
+
name: ("keyword-action"),
|
542
|
+
values: Array[::String]
|
543
|
+
},
|
544
|
+
],
|
545
|
+
?next_token: ::String,
|
546
|
+
?max_results: ::Integer
|
547
|
+
) -> _DescribeKeywordsResponseSuccess
|
548
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeKeywordsResponseSuccess
|
549
|
+
|
550
|
+
interface _DescribeOptOutListsResponseSuccess
|
551
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeOptOutListsResult]
|
552
|
+
def opt_out_lists: () -> ::Array[Types::OptOutListInformation]
|
553
|
+
def next_token: () -> ::String
|
554
|
+
end
|
555
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_opt_out_lists-instance_method
|
556
|
+
def describe_opt_out_lists: (
|
557
|
+
?opt_out_list_names: Array[::String],
|
558
|
+
?next_token: ::String,
|
559
|
+
?max_results: ::Integer
|
560
|
+
) -> _DescribeOptOutListsResponseSuccess
|
561
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeOptOutListsResponseSuccess
|
562
|
+
|
563
|
+
interface _DescribeOptedOutNumbersResponseSuccess
|
564
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeOptedOutNumbersResult]
|
565
|
+
def opt_out_list_arn: () -> ::String
|
566
|
+
def opt_out_list_name: () -> ::String
|
567
|
+
def opted_out_numbers: () -> ::Array[Types::OptedOutNumberInformation]
|
568
|
+
def next_token: () -> ::String
|
569
|
+
end
|
570
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_opted_out_numbers-instance_method
|
571
|
+
def describe_opted_out_numbers: (
|
572
|
+
opt_out_list_name: ::String,
|
573
|
+
?opted_out_numbers: Array[::String],
|
574
|
+
?filters: Array[
|
575
|
+
{
|
576
|
+
name: ("end-user-opted-out"),
|
577
|
+
values: Array[::String]
|
578
|
+
},
|
579
|
+
],
|
580
|
+
?next_token: ::String,
|
581
|
+
?max_results: ::Integer
|
582
|
+
) -> _DescribeOptedOutNumbersResponseSuccess
|
583
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeOptedOutNumbersResponseSuccess
|
584
|
+
|
585
|
+
interface _DescribePhoneNumbersResponseSuccess
|
586
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribePhoneNumbersResult]
|
587
|
+
def phone_numbers: () -> ::Array[Types::PhoneNumberInformation]
|
588
|
+
def next_token: () -> ::String
|
589
|
+
end
|
590
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_phone_numbers-instance_method
|
591
|
+
def describe_phone_numbers: (
|
592
|
+
?phone_number_ids: Array[::String],
|
593
|
+
?filters: Array[
|
594
|
+
{
|
595
|
+
name: ("status" | "iso-country-code" | "message-type" | "number-capability" | "number-type" | "two-way-enabled" | "self-managed-opt-outs-enabled" | "opt-out-list-name" | "deletion-protection-enabled" | "two-way-channel-arn"),
|
596
|
+
values: Array[::String]
|
597
|
+
},
|
598
|
+
],
|
599
|
+
?next_token: ::String,
|
600
|
+
?max_results: ::Integer
|
601
|
+
) -> _DescribePhoneNumbersResponseSuccess
|
602
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribePhoneNumbersResponseSuccess
|
603
|
+
|
604
|
+
interface _DescribePoolsResponseSuccess
|
605
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribePoolsResult]
|
606
|
+
def pools: () -> ::Array[Types::PoolInformation]
|
607
|
+
def next_token: () -> ::String
|
608
|
+
end
|
609
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_pools-instance_method
|
610
|
+
def describe_pools: (
|
611
|
+
?pool_ids: Array[::String],
|
612
|
+
?filters: Array[
|
613
|
+
{
|
614
|
+
name: ("status" | "message-type" | "two-way-enabled" | "self-managed-opt-outs-enabled" | "opt-out-list-name" | "shared-routes-enabled" | "deletion-protection-enabled" | "two-way-channel-arn"),
|
615
|
+
values: Array[::String]
|
616
|
+
},
|
617
|
+
],
|
618
|
+
?next_token: ::String,
|
619
|
+
?max_results: ::Integer
|
620
|
+
) -> _DescribePoolsResponseSuccess
|
621
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribePoolsResponseSuccess
|
622
|
+
|
623
|
+
interface _DescribeRegistrationAttachmentsResponseSuccess
|
624
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationAttachmentsResult]
|
625
|
+
def registration_attachments: () -> ::Array[Types::RegistrationAttachmentsInformation]
|
626
|
+
def next_token: () -> ::String
|
627
|
+
end
|
628
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_attachments-instance_method
|
629
|
+
def describe_registration_attachments: (
|
630
|
+
?registration_attachment_ids: Array[::String],
|
631
|
+
?filters: Array[
|
632
|
+
{
|
633
|
+
name: ("attachment-status"),
|
634
|
+
values: Array[::String]
|
635
|
+
},
|
636
|
+
],
|
637
|
+
?next_token: ::String,
|
638
|
+
?max_results: ::Integer
|
639
|
+
) -> _DescribeRegistrationAttachmentsResponseSuccess
|
640
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationAttachmentsResponseSuccess
|
641
|
+
|
642
|
+
interface _DescribeRegistrationFieldDefinitionsResponseSuccess
|
643
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationFieldDefinitionsResult]
|
644
|
+
def registration_type: () -> ::String
|
645
|
+
def registration_field_definitions: () -> ::Array[Types::RegistrationFieldDefinition]
|
646
|
+
def next_token: () -> ::String
|
647
|
+
end
|
648
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_field_definitions-instance_method
|
649
|
+
def describe_registration_field_definitions: (
|
650
|
+
registration_type: ::String,
|
651
|
+
?section_path: ::String,
|
652
|
+
?field_paths: Array[::String],
|
653
|
+
?next_token: ::String,
|
654
|
+
?max_results: ::Integer
|
655
|
+
) -> _DescribeRegistrationFieldDefinitionsResponseSuccess
|
656
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationFieldDefinitionsResponseSuccess
|
657
|
+
|
658
|
+
interface _DescribeRegistrationFieldValuesResponseSuccess
|
659
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationFieldValuesResult]
|
660
|
+
def registration_arn: () -> ::String
|
661
|
+
def registration_id: () -> ::String
|
662
|
+
def version_number: () -> ::Integer
|
663
|
+
def registration_field_values: () -> ::Array[Types::RegistrationFieldValueInformation]
|
664
|
+
def next_token: () -> ::String
|
665
|
+
end
|
666
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_field_values-instance_method
|
667
|
+
def describe_registration_field_values: (
|
668
|
+
registration_id: ::String,
|
669
|
+
?version_number: ::Integer,
|
670
|
+
?section_path: ::String,
|
671
|
+
?field_paths: Array[::String],
|
672
|
+
?next_token: ::String,
|
673
|
+
?max_results: ::Integer
|
674
|
+
) -> _DescribeRegistrationFieldValuesResponseSuccess
|
675
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationFieldValuesResponseSuccess
|
676
|
+
|
677
|
+
interface _DescribeRegistrationSectionDefinitionsResponseSuccess
|
678
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationSectionDefinitionsResult]
|
679
|
+
def registration_type: () -> ::String
|
680
|
+
def registration_section_definitions: () -> ::Array[Types::RegistrationSectionDefinition]
|
681
|
+
def next_token: () -> ::String
|
682
|
+
end
|
683
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_section_definitions-instance_method
|
684
|
+
def describe_registration_section_definitions: (
|
685
|
+
registration_type: ::String,
|
686
|
+
?section_paths: Array[::String],
|
687
|
+
?next_token: ::String,
|
688
|
+
?max_results: ::Integer
|
689
|
+
) -> _DescribeRegistrationSectionDefinitionsResponseSuccess
|
690
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationSectionDefinitionsResponseSuccess
|
691
|
+
|
692
|
+
interface _DescribeRegistrationTypeDefinitionsResponseSuccess
|
693
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationTypeDefinitionsResult]
|
694
|
+
def registration_type_definitions: () -> ::Array[Types::RegistrationTypeDefinition]
|
695
|
+
def next_token: () -> ::String
|
696
|
+
end
|
697
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_type_definitions-instance_method
|
698
|
+
def describe_registration_type_definitions: (
|
699
|
+
?registration_types: Array[::String],
|
700
|
+
?filters: Array[
|
701
|
+
{
|
702
|
+
name: ("supported-association-resource-type" | "supported-association-iso-country-code"),
|
703
|
+
values: Array[::String]
|
704
|
+
},
|
705
|
+
],
|
706
|
+
?next_token: ::String,
|
707
|
+
?max_results: ::Integer
|
708
|
+
) -> _DescribeRegistrationTypeDefinitionsResponseSuccess
|
709
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationTypeDefinitionsResponseSuccess
|
710
|
+
|
711
|
+
interface _DescribeRegistrationVersionsResponseSuccess
|
712
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationVersionsResult]
|
713
|
+
def registration_arn: () -> ::String
|
714
|
+
def registration_id: () -> ::String
|
715
|
+
def registration_versions: () -> ::Array[Types::RegistrationVersionInformation]
|
716
|
+
def next_token: () -> ::String
|
717
|
+
end
|
718
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registration_versions-instance_method
|
719
|
+
def describe_registration_versions: (
|
720
|
+
registration_id: ::String,
|
721
|
+
?version_numbers: Array[::Integer],
|
722
|
+
?filters: Array[
|
723
|
+
{
|
724
|
+
name: ("registration-version-status"),
|
725
|
+
values: Array[::String]
|
726
|
+
},
|
727
|
+
],
|
728
|
+
?next_token: ::String,
|
729
|
+
?max_results: ::Integer
|
730
|
+
) -> _DescribeRegistrationVersionsResponseSuccess
|
731
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationVersionsResponseSuccess
|
732
|
+
|
733
|
+
interface _DescribeRegistrationsResponseSuccess
|
734
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRegistrationsResult]
|
735
|
+
def registrations: () -> ::Array[Types::RegistrationInformation]
|
736
|
+
def next_token: () -> ::String
|
737
|
+
end
|
738
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_registrations-instance_method
|
739
|
+
def describe_registrations: (
|
740
|
+
?registration_ids: Array[::String],
|
741
|
+
?filters: Array[
|
742
|
+
{
|
743
|
+
name: ("registration-type" | "registration-status"),
|
744
|
+
values: Array[::String]
|
745
|
+
},
|
746
|
+
],
|
747
|
+
?next_token: ::String,
|
748
|
+
?max_results: ::Integer
|
749
|
+
) -> _DescribeRegistrationsResponseSuccess
|
750
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRegistrationsResponseSuccess
|
751
|
+
|
752
|
+
interface _DescribeSenderIdsResponseSuccess
|
753
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeSenderIdsResult]
|
754
|
+
def sender_ids: () -> ::Array[Types::SenderIdInformation]
|
755
|
+
def next_token: () -> ::String
|
756
|
+
end
|
757
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_sender_ids-instance_method
|
758
|
+
def describe_sender_ids: (
|
759
|
+
?sender_ids: Array[
|
760
|
+
{
|
761
|
+
sender_id: ::String,
|
762
|
+
iso_country_code: ::String
|
763
|
+
},
|
764
|
+
],
|
765
|
+
?filters: Array[
|
766
|
+
{
|
767
|
+
name: ("sender-id" | "iso-country-code" | "message-type" | "deletion-protection-enabled" | "registered"),
|
768
|
+
values: Array[::String]
|
769
|
+
},
|
770
|
+
],
|
771
|
+
?next_token: ::String,
|
772
|
+
?max_results: ::Integer
|
773
|
+
) -> _DescribeSenderIdsResponseSuccess
|
774
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeSenderIdsResponseSuccess
|
775
|
+
|
776
|
+
interface _DescribeSpendLimitsResponseSuccess
|
777
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeSpendLimitsResult]
|
778
|
+
def spend_limits: () -> ::Array[Types::SpendLimit]
|
779
|
+
def next_token: () -> ::String
|
780
|
+
end
|
781
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_spend_limits-instance_method
|
782
|
+
def describe_spend_limits: (
|
783
|
+
?next_token: ::String,
|
784
|
+
?max_results: ::Integer
|
785
|
+
) -> _DescribeSpendLimitsResponseSuccess
|
786
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeSpendLimitsResponseSuccess
|
787
|
+
|
788
|
+
interface _DescribeVerifiedDestinationNumbersResponseSuccess
|
789
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeVerifiedDestinationNumbersResult]
|
790
|
+
def verified_destination_numbers: () -> ::Array[Types::VerifiedDestinationNumberInformation]
|
791
|
+
def next_token: () -> ::String
|
792
|
+
end
|
793
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#describe_verified_destination_numbers-instance_method
|
794
|
+
def describe_verified_destination_numbers: (
|
795
|
+
?verified_destination_number_ids: Array[::String],
|
796
|
+
?destination_phone_numbers: Array[::String],
|
797
|
+
?filters: Array[
|
798
|
+
{
|
799
|
+
name: ("status"),
|
800
|
+
values: Array[::String]
|
801
|
+
},
|
802
|
+
],
|
803
|
+
?next_token: ::String,
|
804
|
+
?max_results: ::Integer
|
805
|
+
) -> _DescribeVerifiedDestinationNumbersResponseSuccess
|
806
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeVerifiedDestinationNumbersResponseSuccess
|
807
|
+
|
808
|
+
interface _DisassociateOriginationIdentityResponseSuccess
|
809
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateOriginationIdentityResult]
|
810
|
+
def pool_arn: () -> ::String
|
811
|
+
def pool_id: () -> ::String
|
812
|
+
def origination_identity_arn: () -> ::String
|
813
|
+
def origination_identity: () -> ::String
|
814
|
+
def iso_country_code: () -> ::String
|
815
|
+
end
|
816
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#disassociate_origination_identity-instance_method
|
817
|
+
def disassociate_origination_identity: (
|
818
|
+
pool_id: ::String,
|
819
|
+
origination_identity: ::String,
|
820
|
+
iso_country_code: ::String,
|
821
|
+
?client_token: ::String
|
822
|
+
) -> _DisassociateOriginationIdentityResponseSuccess
|
823
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateOriginationIdentityResponseSuccess
|
824
|
+
|
825
|
+
interface _DiscardRegistrationVersionResponseSuccess
|
826
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DiscardRegistrationVersionResult]
|
827
|
+
def registration_arn: () -> ::String
|
828
|
+
def registration_id: () -> ::String
|
829
|
+
def version_number: () -> ::Integer
|
830
|
+
def registration_version_status: () -> ("DRAFT" | "SUBMITTED" | "REVIEWING" | "APPROVED" | "DISCARDED" | "DENIED" | "REVOKED" | "ARCHIVED")
|
831
|
+
def registration_version_status_history: () -> Types::RegistrationVersionStatusHistory
|
832
|
+
end
|
833
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#discard_registration_version-instance_method
|
834
|
+
def discard_registration_version: (
|
835
|
+
registration_id: ::String
|
836
|
+
) -> _DiscardRegistrationVersionResponseSuccess
|
837
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DiscardRegistrationVersionResponseSuccess
|
838
|
+
|
839
|
+
interface _ListPoolOriginationIdentitiesResponseSuccess
|
840
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPoolOriginationIdentitiesResult]
|
841
|
+
def pool_arn: () -> ::String
|
842
|
+
def pool_id: () -> ::String
|
843
|
+
def origination_identities: () -> ::Array[Types::OriginationIdentityMetadata]
|
844
|
+
def next_token: () -> ::String
|
845
|
+
end
|
846
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#list_pool_origination_identities-instance_method
|
847
|
+
def list_pool_origination_identities: (
|
848
|
+
pool_id: ::String,
|
849
|
+
?filters: Array[
|
850
|
+
{
|
851
|
+
name: ("iso-country-code" | "number-capability"),
|
852
|
+
values: Array[::String]
|
853
|
+
},
|
854
|
+
],
|
855
|
+
?next_token: ::String,
|
856
|
+
?max_results: ::Integer
|
857
|
+
) -> _ListPoolOriginationIdentitiesResponseSuccess
|
858
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPoolOriginationIdentitiesResponseSuccess
|
859
|
+
|
860
|
+
interface _ListRegistrationAssociationsResponseSuccess
|
861
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListRegistrationAssociationsResult]
|
862
|
+
def registration_arn: () -> ::String
|
863
|
+
def registration_id: () -> ::String
|
864
|
+
def registration_type: () -> ::String
|
865
|
+
def registration_associations: () -> ::Array[Types::RegistrationAssociationMetadata]
|
866
|
+
def next_token: () -> ::String
|
867
|
+
end
|
868
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#list_registration_associations-instance_method
|
869
|
+
def list_registration_associations: (
|
870
|
+
registration_id: ::String,
|
871
|
+
?filters: Array[
|
872
|
+
{
|
873
|
+
name: ("resource-type" | "iso-country-code"),
|
874
|
+
values: Array[::String]
|
875
|
+
},
|
876
|
+
],
|
877
|
+
?next_token: ::String,
|
878
|
+
?max_results: ::Integer
|
879
|
+
) -> _ListRegistrationAssociationsResponseSuccess
|
880
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRegistrationAssociationsResponseSuccess
|
881
|
+
|
882
|
+
interface _ListTagsForResourceResponseSuccess
|
883
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResult]
|
884
|
+
def resource_arn: () -> ::String
|
885
|
+
def tags: () -> ::Array[Types::Tag]
|
886
|
+
end
|
887
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#list_tags_for_resource-instance_method
|
888
|
+
def list_tags_for_resource: (
|
889
|
+
resource_arn: ::String
|
890
|
+
) -> _ListTagsForResourceResponseSuccess
|
891
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
892
|
+
|
893
|
+
interface _PutKeywordResponseSuccess
|
894
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutKeywordResult]
|
895
|
+
def origination_identity_arn: () -> ::String
|
896
|
+
def origination_identity: () -> ::String
|
897
|
+
def keyword: () -> ::String
|
898
|
+
def keyword_message: () -> ::String
|
899
|
+
def keyword_action: () -> ("AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN")
|
900
|
+
end
|
901
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#put_keyword-instance_method
|
902
|
+
def put_keyword: (
|
903
|
+
origination_identity: ::String,
|
904
|
+
keyword: ::String,
|
905
|
+
keyword_message: ::String,
|
906
|
+
?keyword_action: ("AUTOMATIC_RESPONSE" | "OPT_OUT" | "OPT_IN")
|
907
|
+
) -> _PutKeywordResponseSuccess
|
908
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutKeywordResponseSuccess
|
909
|
+
|
910
|
+
interface _PutOptedOutNumberResponseSuccess
|
911
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutOptedOutNumberResult]
|
912
|
+
def opt_out_list_arn: () -> ::String
|
913
|
+
def opt_out_list_name: () -> ::String
|
914
|
+
def opted_out_number: () -> ::String
|
915
|
+
def opted_out_timestamp: () -> ::Time
|
916
|
+
def end_user_opted_out: () -> bool
|
917
|
+
end
|
918
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#put_opted_out_number-instance_method
|
919
|
+
def put_opted_out_number: (
|
920
|
+
opt_out_list_name: ::String,
|
921
|
+
opted_out_number: ::String
|
922
|
+
) -> _PutOptedOutNumberResponseSuccess
|
923
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutOptedOutNumberResponseSuccess
|
924
|
+
|
925
|
+
interface _PutRegistrationFieldValueResponseSuccess
|
926
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutRegistrationFieldValueResult]
|
927
|
+
def registration_arn: () -> ::String
|
928
|
+
def registration_id: () -> ::String
|
929
|
+
def version_number: () -> ::Integer
|
930
|
+
def field_path: () -> ::String
|
931
|
+
def select_choices: () -> ::Array[::String]
|
932
|
+
def text_value: () -> ::String
|
933
|
+
def registration_attachment_id: () -> ::String
|
934
|
+
end
|
935
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#put_registration_field_value-instance_method
|
936
|
+
def put_registration_field_value: (
|
937
|
+
registration_id: ::String,
|
938
|
+
field_path: ::String,
|
939
|
+
?select_choices: Array[::String],
|
940
|
+
?text_value: ::String,
|
941
|
+
?registration_attachment_id: ::String
|
942
|
+
) -> _PutRegistrationFieldValueResponseSuccess
|
943
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutRegistrationFieldValueResponseSuccess
|
944
|
+
|
945
|
+
interface _ReleasePhoneNumberResponseSuccess
|
946
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ReleasePhoneNumberResult]
|
947
|
+
def phone_number_arn: () -> ::String
|
948
|
+
def phone_number_id: () -> ::String
|
949
|
+
def phone_number: () -> ::String
|
950
|
+
def status: () -> ("PENDING" | "ACTIVE" | "ASSOCIATING" | "DISASSOCIATING" | "DELETED")
|
951
|
+
def iso_country_code: () -> ::String
|
952
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
953
|
+
def number_capabilities: () -> ::Array[("SMS" | "VOICE")]
|
954
|
+
def number_type: () -> ("SHORT_CODE" | "LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR")
|
955
|
+
def monthly_leasing_price: () -> ::String
|
956
|
+
def two_way_enabled: () -> bool
|
957
|
+
def two_way_channel_arn: () -> ::String
|
958
|
+
def two_way_channel_role: () -> ::String
|
959
|
+
def self_managed_opt_outs_enabled: () -> bool
|
960
|
+
def opt_out_list_name: () -> ::String
|
961
|
+
def registration_id: () -> ::String
|
962
|
+
def created_timestamp: () -> ::Time
|
963
|
+
end
|
964
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#release_phone_number-instance_method
|
965
|
+
def release_phone_number: (
|
966
|
+
phone_number_id: ::String
|
967
|
+
) -> _ReleasePhoneNumberResponseSuccess
|
968
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ReleasePhoneNumberResponseSuccess
|
969
|
+
|
970
|
+
interface _ReleaseSenderIdResponseSuccess
|
971
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ReleaseSenderIdResult]
|
972
|
+
def sender_id_arn: () -> ::String
|
973
|
+
def sender_id: () -> ::String
|
974
|
+
def iso_country_code: () -> ::String
|
975
|
+
def message_types: () -> ::Array[("TRANSACTIONAL" | "PROMOTIONAL")]
|
976
|
+
def monthly_leasing_price: () -> ::String
|
977
|
+
def registered: () -> bool
|
978
|
+
def registration_id: () -> ::String
|
979
|
+
end
|
980
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#release_sender_id-instance_method
|
981
|
+
def release_sender_id: (
|
982
|
+
sender_id: ::String,
|
983
|
+
iso_country_code: ::String
|
984
|
+
) -> _ReleaseSenderIdResponseSuccess
|
985
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ReleaseSenderIdResponseSuccess
|
986
|
+
|
987
|
+
interface _RequestPhoneNumberResponseSuccess
|
988
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RequestPhoneNumberResult]
|
989
|
+
def phone_number_arn: () -> ::String
|
990
|
+
def phone_number_id: () -> ::String
|
991
|
+
def phone_number: () -> ::String
|
992
|
+
def status: () -> ("PENDING" | "ACTIVE" | "ASSOCIATING" | "DISASSOCIATING" | "DELETED")
|
993
|
+
def iso_country_code: () -> ::String
|
994
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
995
|
+
def number_capabilities: () -> ::Array[("SMS" | "VOICE")]
|
996
|
+
def number_type: () -> ("LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR")
|
997
|
+
def monthly_leasing_price: () -> ::String
|
998
|
+
def two_way_enabled: () -> bool
|
999
|
+
def two_way_channel_arn: () -> ::String
|
1000
|
+
def two_way_channel_role: () -> ::String
|
1001
|
+
def self_managed_opt_outs_enabled: () -> bool
|
1002
|
+
def opt_out_list_name: () -> ::String
|
1003
|
+
def deletion_protection_enabled: () -> bool
|
1004
|
+
def pool_id: () -> ::String
|
1005
|
+
def registration_id: () -> ::String
|
1006
|
+
def tags: () -> ::Array[Types::Tag]
|
1007
|
+
def created_timestamp: () -> ::Time
|
1008
|
+
end
|
1009
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#request_phone_number-instance_method
|
1010
|
+
def request_phone_number: (
|
1011
|
+
iso_country_code: ::String,
|
1012
|
+
message_type: ("TRANSACTIONAL" | "PROMOTIONAL"),
|
1013
|
+
number_capabilities: Array[("SMS" | "VOICE")],
|
1014
|
+
number_type: ("LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR"),
|
1015
|
+
?opt_out_list_name: ::String,
|
1016
|
+
?pool_id: ::String,
|
1017
|
+
?registration_id: ::String,
|
1018
|
+
?deletion_protection_enabled: bool,
|
1019
|
+
?tags: Array[
|
1020
|
+
{
|
1021
|
+
key: ::String,
|
1022
|
+
value: ::String
|
1023
|
+
},
|
1024
|
+
],
|
1025
|
+
?client_token: ::String
|
1026
|
+
) -> _RequestPhoneNumberResponseSuccess
|
1027
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RequestPhoneNumberResponseSuccess
|
1028
|
+
|
1029
|
+
interface _RequestSenderIdResponseSuccess
|
1030
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RequestSenderIdResult]
|
1031
|
+
def sender_id_arn: () -> ::String
|
1032
|
+
def sender_id: () -> ::String
|
1033
|
+
def iso_country_code: () -> ::String
|
1034
|
+
def message_types: () -> ::Array[("TRANSACTIONAL" | "PROMOTIONAL")]
|
1035
|
+
def monthly_leasing_price: () -> ::String
|
1036
|
+
def deletion_protection_enabled: () -> bool
|
1037
|
+
def registered: () -> bool
|
1038
|
+
def tags: () -> ::Array[Types::Tag]
|
1039
|
+
end
|
1040
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#request_sender_id-instance_method
|
1041
|
+
def request_sender_id: (
|
1042
|
+
sender_id: ::String,
|
1043
|
+
iso_country_code: ::String,
|
1044
|
+
?message_types: Array[("TRANSACTIONAL" | "PROMOTIONAL")],
|
1045
|
+
?deletion_protection_enabled: bool,
|
1046
|
+
?tags: Array[
|
1047
|
+
{
|
1048
|
+
key: ::String,
|
1049
|
+
value: ::String
|
1050
|
+
},
|
1051
|
+
],
|
1052
|
+
?client_token: ::String
|
1053
|
+
) -> _RequestSenderIdResponseSuccess
|
1054
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RequestSenderIdResponseSuccess
|
1055
|
+
|
1056
|
+
interface _SendDestinationNumberVerificationCodeResponseSuccess
|
1057
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendDestinationNumberVerificationCodeResult]
|
1058
|
+
def message_id: () -> ::String
|
1059
|
+
end
|
1060
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#send_destination_number_verification_code-instance_method
|
1061
|
+
def send_destination_number_verification_code: (
|
1062
|
+
verified_destination_number_id: ::String,
|
1063
|
+
verification_channel: ("TEXT" | "VOICE"),
|
1064
|
+
?language_code: ("DE_DE" | "EN_GB" | "EN_US" | "ES_419" | "ES_ES" | "FR_CA" | "FR_FR" | "IT_IT" | "JA_JP" | "KO_KR" | "PT_BR" | "ZH_CN" | "ZH_TW"),
|
1065
|
+
?origination_identity: ::String,
|
1066
|
+
?configuration_set_name: ::String,
|
1067
|
+
?context: Hash[::String, ::String],
|
1068
|
+
?destination_country_parameters: Hash[("IN_TEMPLATE_ID" | "IN_ENTITY_ID"), ::String]
|
1069
|
+
) -> _SendDestinationNumberVerificationCodeResponseSuccess
|
1070
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendDestinationNumberVerificationCodeResponseSuccess
|
1071
|
+
|
1072
|
+
interface _SendTextMessageResponseSuccess
|
1073
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendTextMessageResult]
|
1074
|
+
def message_id: () -> ::String
|
1075
|
+
end
|
1076
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#send_text_message-instance_method
|
1077
|
+
def send_text_message: (
|
1078
|
+
destination_phone_number: ::String,
|
1079
|
+
?origination_identity: ::String,
|
1080
|
+
?message_body: ::String,
|
1081
|
+
?message_type: ("TRANSACTIONAL" | "PROMOTIONAL"),
|
1082
|
+
?keyword: ::String,
|
1083
|
+
?configuration_set_name: ::String,
|
1084
|
+
?max_price: ::String,
|
1085
|
+
?time_to_live: ::Integer,
|
1086
|
+
?context: Hash[::String, ::String],
|
1087
|
+
?destination_country_parameters: Hash[("IN_TEMPLATE_ID" | "IN_ENTITY_ID"), ::String],
|
1088
|
+
?dry_run: bool
|
1089
|
+
) -> _SendTextMessageResponseSuccess
|
1090
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendTextMessageResponseSuccess
|
1091
|
+
|
1092
|
+
interface _SendVoiceMessageResponseSuccess
|
1093
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendVoiceMessageResult]
|
1094
|
+
def message_id: () -> ::String
|
1095
|
+
end
|
1096
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#send_voice_message-instance_method
|
1097
|
+
def send_voice_message: (
|
1098
|
+
destination_phone_number: ::String,
|
1099
|
+
origination_identity: ::String,
|
1100
|
+
?message_body: ::String,
|
1101
|
+
?message_body_text_type: ("TEXT" | "SSML"),
|
1102
|
+
?voice_id: ("AMY" | "ASTRID" | "BIANCA" | "BRIAN" | "CAMILA" | "CARLA" | "CARMEN" | "CELINE" | "CHANTAL" | "CONCHITA" | "CRISTIANO" | "DORA" | "EMMA" | "ENRIQUE" | "EWA" | "FILIZ" | "GERAINT" | "GIORGIO" | "GWYNETH" | "HANS" | "INES" | "IVY" | "JACEK" | "JAN" | "JOANNA" | "JOEY" | "JUSTIN" | "KARL" | "KENDRA" | "KIMBERLY" | "LEA" | "LIV" | "LOTTE" | "LUCIA" | "LUPE" | "MADS" | "MAJA" | "MARLENE" | "MATHIEU" | "MATTHEW" | "MAXIM" | "MIA" | "MIGUEL" | "MIZUKI" | "NAJA" | "NICOLE" | "PENELOPE" | "RAVEENA" | "RICARDO" | "RUBEN" | "RUSSELL" | "SALLI" | "SEOYEON" | "TAKUMI" | "TATYANA" | "VICKI" | "VITORIA" | "ZEINA" | "ZHIYU"),
|
1103
|
+
?configuration_set_name: ::String,
|
1104
|
+
?max_price_per_minute: ::String,
|
1105
|
+
?time_to_live: ::Integer,
|
1106
|
+
?context: Hash[::String, ::String],
|
1107
|
+
?dry_run: bool
|
1108
|
+
) -> _SendVoiceMessageResponseSuccess
|
1109
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendVoiceMessageResponseSuccess
|
1110
|
+
|
1111
|
+
interface _SetDefaultMessageTypeResponseSuccess
|
1112
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetDefaultMessageTypeResult]
|
1113
|
+
def configuration_set_arn: () -> ::String
|
1114
|
+
def configuration_set_name: () -> ::String
|
1115
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
1116
|
+
end
|
1117
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#set_default_message_type-instance_method
|
1118
|
+
def set_default_message_type: (
|
1119
|
+
configuration_set_name: ::String,
|
1120
|
+
message_type: ("TRANSACTIONAL" | "PROMOTIONAL")
|
1121
|
+
) -> _SetDefaultMessageTypeResponseSuccess
|
1122
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetDefaultMessageTypeResponseSuccess
|
1123
|
+
|
1124
|
+
interface _SetDefaultSenderIdResponseSuccess
|
1125
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetDefaultSenderIdResult]
|
1126
|
+
def configuration_set_arn: () -> ::String
|
1127
|
+
def configuration_set_name: () -> ::String
|
1128
|
+
def sender_id: () -> ::String
|
1129
|
+
end
|
1130
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#set_default_sender_id-instance_method
|
1131
|
+
def set_default_sender_id: (
|
1132
|
+
configuration_set_name: ::String,
|
1133
|
+
sender_id: ::String
|
1134
|
+
) -> _SetDefaultSenderIdResponseSuccess
|
1135
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetDefaultSenderIdResponseSuccess
|
1136
|
+
|
1137
|
+
interface _SetTextMessageSpendLimitOverrideResponseSuccess
|
1138
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetTextMessageSpendLimitOverrideResult]
|
1139
|
+
def monthly_limit: () -> ::Integer
|
1140
|
+
end
|
1141
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#set_text_message_spend_limit_override-instance_method
|
1142
|
+
def set_text_message_spend_limit_override: (
|
1143
|
+
monthly_limit: ::Integer
|
1144
|
+
) -> _SetTextMessageSpendLimitOverrideResponseSuccess
|
1145
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetTextMessageSpendLimitOverrideResponseSuccess
|
1146
|
+
|
1147
|
+
interface _SetVoiceMessageSpendLimitOverrideResponseSuccess
|
1148
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetVoiceMessageSpendLimitOverrideResult]
|
1149
|
+
def monthly_limit: () -> ::Integer
|
1150
|
+
end
|
1151
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#set_voice_message_spend_limit_override-instance_method
|
1152
|
+
def set_voice_message_spend_limit_override: (
|
1153
|
+
monthly_limit: ::Integer
|
1154
|
+
) -> _SetVoiceMessageSpendLimitOverrideResponseSuccess
|
1155
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetVoiceMessageSpendLimitOverrideResponseSuccess
|
1156
|
+
|
1157
|
+
interface _SubmitRegistrationVersionResponseSuccess
|
1158
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SubmitRegistrationVersionResult]
|
1159
|
+
def registration_arn: () -> ::String
|
1160
|
+
def registration_id: () -> ::String
|
1161
|
+
def version_number: () -> ::Integer
|
1162
|
+
def registration_version_status: () -> ("DRAFT" | "SUBMITTED" | "REVIEWING" | "APPROVED" | "DISCARDED" | "DENIED" | "REVOKED" | "ARCHIVED")
|
1163
|
+
def registration_version_status_history: () -> Types::RegistrationVersionStatusHistory
|
1164
|
+
end
|
1165
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#submit_registration_version-instance_method
|
1166
|
+
def submit_registration_version: (
|
1167
|
+
registration_id: ::String
|
1168
|
+
) -> _SubmitRegistrationVersionResponseSuccess
|
1169
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SubmitRegistrationVersionResponseSuccess
|
1170
|
+
|
1171
|
+
interface _TagResourceResponseSuccess
|
1172
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResult]
|
1173
|
+
end
|
1174
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#tag_resource-instance_method
|
1175
|
+
def tag_resource: (
|
1176
|
+
resource_arn: ::String,
|
1177
|
+
tags: Array[
|
1178
|
+
{
|
1179
|
+
key: ::String,
|
1180
|
+
value: ::String
|
1181
|
+
},
|
1182
|
+
]
|
1183
|
+
) -> _TagResourceResponseSuccess
|
1184
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
1185
|
+
|
1186
|
+
interface _UntagResourceResponseSuccess
|
1187
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResult]
|
1188
|
+
end
|
1189
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#untag_resource-instance_method
|
1190
|
+
def untag_resource: (
|
1191
|
+
resource_arn: ::String,
|
1192
|
+
tag_keys: Array[::String]
|
1193
|
+
) -> _UntagResourceResponseSuccess
|
1194
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
1195
|
+
|
1196
|
+
interface _UpdateEventDestinationResponseSuccess
|
1197
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateEventDestinationResult]
|
1198
|
+
def configuration_set_arn: () -> ::String
|
1199
|
+
def configuration_set_name: () -> ::String
|
1200
|
+
def event_destination: () -> Types::EventDestination
|
1201
|
+
end
|
1202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#update_event_destination-instance_method
|
1203
|
+
def update_event_destination: (
|
1204
|
+
configuration_set_name: ::String,
|
1205
|
+
event_destination_name: ::String,
|
1206
|
+
?enabled: bool,
|
1207
|
+
?matching_event_types: Array[("ALL" | "TEXT_ALL" | "TEXT_SENT" | "TEXT_PENDING" | "TEXT_QUEUED" | "TEXT_SUCCESSFUL" | "TEXT_DELIVERED" | "TEXT_INVALID" | "TEXT_INVALID_MESSAGE" | "TEXT_UNREACHABLE" | "TEXT_CARRIER_UNREACHABLE" | "TEXT_BLOCKED" | "TEXT_CARRIER_BLOCKED" | "TEXT_SPAM" | "TEXT_UNKNOWN" | "TEXT_TTL_EXPIRED" | "VOICE_ALL" | "VOICE_INITIATED" | "VOICE_RINGING" | "VOICE_ANSWERED" | "VOICE_COMPLETED" | "VOICE_BUSY" | "VOICE_NO_ANSWER" | "VOICE_FAILED" | "VOICE_TTL_EXPIRED")],
|
1208
|
+
?cloud_watch_logs_destination: {
|
1209
|
+
iam_role_arn: ::String,
|
1210
|
+
log_group_arn: ::String
|
1211
|
+
},
|
1212
|
+
?kinesis_firehose_destination: {
|
1213
|
+
iam_role_arn: ::String,
|
1214
|
+
delivery_stream_arn: ::String
|
1215
|
+
},
|
1216
|
+
?sns_destination: {
|
1217
|
+
topic_arn: ::String
|
1218
|
+
}
|
1219
|
+
) -> _UpdateEventDestinationResponseSuccess
|
1220
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateEventDestinationResponseSuccess
|
1221
|
+
|
1222
|
+
interface _UpdatePhoneNumberResponseSuccess
|
1223
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePhoneNumberResult]
|
1224
|
+
def phone_number_arn: () -> ::String
|
1225
|
+
def phone_number_id: () -> ::String
|
1226
|
+
def phone_number: () -> ::String
|
1227
|
+
def status: () -> ("PENDING" | "ACTIVE" | "ASSOCIATING" | "DISASSOCIATING" | "DELETED")
|
1228
|
+
def iso_country_code: () -> ::String
|
1229
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
1230
|
+
def number_capabilities: () -> ::Array[("SMS" | "VOICE")]
|
1231
|
+
def number_type: () -> ("SHORT_CODE" | "LONG_CODE" | "TOLL_FREE" | "TEN_DLC" | "SIMULATOR")
|
1232
|
+
def monthly_leasing_price: () -> ::String
|
1233
|
+
def two_way_enabled: () -> bool
|
1234
|
+
def two_way_channel_arn: () -> ::String
|
1235
|
+
def two_way_channel_role: () -> ::String
|
1236
|
+
def self_managed_opt_outs_enabled: () -> bool
|
1237
|
+
def opt_out_list_name: () -> ::String
|
1238
|
+
def deletion_protection_enabled: () -> bool
|
1239
|
+
def registration_id: () -> ::String
|
1240
|
+
def created_timestamp: () -> ::Time
|
1241
|
+
end
|
1242
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#update_phone_number-instance_method
|
1243
|
+
def update_phone_number: (
|
1244
|
+
phone_number_id: ::String,
|
1245
|
+
?two_way_enabled: bool,
|
1246
|
+
?two_way_channel_arn: ::String,
|
1247
|
+
?two_way_channel_role: ::String,
|
1248
|
+
?self_managed_opt_outs_enabled: bool,
|
1249
|
+
?opt_out_list_name: ::String,
|
1250
|
+
?deletion_protection_enabled: bool
|
1251
|
+
) -> _UpdatePhoneNumberResponseSuccess
|
1252
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePhoneNumberResponseSuccess
|
1253
|
+
|
1254
|
+
interface _UpdatePoolResponseSuccess
|
1255
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePoolResult]
|
1256
|
+
def pool_arn: () -> ::String
|
1257
|
+
def pool_id: () -> ::String
|
1258
|
+
def status: () -> ("CREATING" | "ACTIVE" | "DELETING")
|
1259
|
+
def message_type: () -> ("TRANSACTIONAL" | "PROMOTIONAL")
|
1260
|
+
def two_way_enabled: () -> bool
|
1261
|
+
def two_way_channel_arn: () -> ::String
|
1262
|
+
def two_way_channel_role: () -> ::String
|
1263
|
+
def self_managed_opt_outs_enabled: () -> bool
|
1264
|
+
def opt_out_list_name: () -> ::String
|
1265
|
+
def shared_routes_enabled: () -> bool
|
1266
|
+
def deletion_protection_enabled: () -> bool
|
1267
|
+
def created_timestamp: () -> ::Time
|
1268
|
+
end
|
1269
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#update_pool-instance_method
|
1270
|
+
def update_pool: (
|
1271
|
+
pool_id: ::String,
|
1272
|
+
?two_way_enabled: bool,
|
1273
|
+
?two_way_channel_arn: ::String,
|
1274
|
+
?two_way_channel_role: ::String,
|
1275
|
+
?self_managed_opt_outs_enabled: bool,
|
1276
|
+
?opt_out_list_name: ::String,
|
1277
|
+
?shared_routes_enabled: bool,
|
1278
|
+
?deletion_protection_enabled: bool
|
1279
|
+
) -> _UpdatePoolResponseSuccess
|
1280
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdatePoolResponseSuccess
|
1281
|
+
|
1282
|
+
interface _UpdateSenderIdResponseSuccess
|
1283
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSenderIdResult]
|
1284
|
+
def sender_id_arn: () -> ::String
|
1285
|
+
def sender_id: () -> ::String
|
1286
|
+
def iso_country_code: () -> ::String
|
1287
|
+
def message_types: () -> ::Array[("TRANSACTIONAL" | "PROMOTIONAL")]
|
1288
|
+
def monthly_leasing_price: () -> ::String
|
1289
|
+
def deletion_protection_enabled: () -> bool
|
1290
|
+
def registered: () -> bool
|
1291
|
+
def registration_id: () -> ::String
|
1292
|
+
end
|
1293
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#update_sender_id-instance_method
|
1294
|
+
def update_sender_id: (
|
1295
|
+
sender_id: ::String,
|
1296
|
+
iso_country_code: ::String,
|
1297
|
+
?deletion_protection_enabled: bool
|
1298
|
+
) -> _UpdateSenderIdResponseSuccess
|
1299
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSenderIdResponseSuccess
|
1300
|
+
|
1301
|
+
interface _VerifyDestinationNumberResponseSuccess
|
1302
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifyDestinationNumberResult]
|
1303
|
+
def verified_destination_number_arn: () -> ::String
|
1304
|
+
def verified_destination_number_id: () -> ::String
|
1305
|
+
def destination_phone_number: () -> ::String
|
1306
|
+
def status: () -> ("PENDING" | "VERIFIED")
|
1307
|
+
def created_timestamp: () -> ::Time
|
1308
|
+
end
|
1309
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PinpointSMSVoiceV2/Client.html#verify_destination_number-instance_method
|
1310
|
+
def verify_destination_number: (
|
1311
|
+
verified_destination_number_id: ::String,
|
1312
|
+
verification_code: ::String
|
1313
|
+
) -> _VerifyDestinationNumberResponseSuccess
|
1314
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifyDestinationNumberResponseSuccess
|
1315
|
+
end
|
1316
|
+
end
|
1317
|
+
end
|
1318
|
+
|