aws-sdk-endusermessaging 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/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-endusermessaging/client.rb +2706 -0
- data/lib/aws-sdk-endusermessaging/client_api.rb +1071 -0
- data/lib/aws-sdk-endusermessaging/customizations.rb +0 -0
- data/lib/aws-sdk-endusermessaging/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-endusermessaging/endpoint_provider.rb +50 -0
- data/lib/aws-sdk-endusermessaging/endpoints.rb +20 -0
- data/lib/aws-sdk-endusermessaging/errors.rb +187 -0
- data/lib/aws-sdk-endusermessaging/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-endusermessaging/resource.rb +26 -0
- data/lib/aws-sdk-endusermessaging/types.rb +2249 -0
- data/lib/aws-sdk-endusermessaging/waiters.rb +179 -0
- data/lib/aws-sdk-endusermessaging.rb +62 -0
- data/sig/client.rbs +535 -0
- data/sig/errors.rbs +42 -0
- data/sig/params.rbs +34 -0
- data/sig/resource.rbs +85 -0
- data/sig/types.rbs +607 -0
- data/sig/waiters.rbs +33 -0
- metadata +98 -0
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,535 @@
|
|
|
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 EndUserMessaging
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#initialize-instance_method
|
|
14
|
+
def self.new: (
|
|
15
|
+
?credentials: untyped,
|
|
16
|
+
?region: String,
|
|
17
|
+
?access_key_id: String,
|
|
18
|
+
?account_id: String,
|
|
19
|
+
?active_endpoint_cache: bool,
|
|
20
|
+
?adaptive_retry_wait_to_fill: bool,
|
|
21
|
+
?auth_scheme_preference: Array[String],
|
|
22
|
+
?client_side_monitoring: bool,
|
|
23
|
+
?client_side_monitoring_client_id: String,
|
|
24
|
+
?client_side_monitoring_host: String,
|
|
25
|
+
?client_side_monitoring_port: Integer,
|
|
26
|
+
?client_side_monitoring_publisher: untyped,
|
|
27
|
+
?convert_params: bool,
|
|
28
|
+
?correct_clock_skew: bool,
|
|
29
|
+
?defaults_mode: String,
|
|
30
|
+
?disable_host_prefix_injection: bool,
|
|
31
|
+
?disable_request_compression: bool,
|
|
32
|
+
?endpoint: String,
|
|
33
|
+
?endpoint_cache_max_entries: Integer,
|
|
34
|
+
?endpoint_cache_max_threads: Integer,
|
|
35
|
+
?endpoint_cache_poll_interval: Integer,
|
|
36
|
+
?endpoint_discovery: bool,
|
|
37
|
+
?ignore_configured_endpoint_urls: bool,
|
|
38
|
+
?log_formatter: untyped,
|
|
39
|
+
?log_level: Symbol,
|
|
40
|
+
?logger: untyped,
|
|
41
|
+
?max_attempts: Integer,
|
|
42
|
+
?profile: String,
|
|
43
|
+
?request_checksum_calculation: String,
|
|
44
|
+
?request_min_compression_size_bytes: Integer,
|
|
45
|
+
?response_checksum_validation: String,
|
|
46
|
+
?retry_backoff: Proc,
|
|
47
|
+
?retry_base_delay: Float,
|
|
48
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
|
49
|
+
?retry_limit: Integer,
|
|
50
|
+
?retry_max_delay: Integer,
|
|
51
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
|
52
|
+
?sdk_ua_app_id: String,
|
|
53
|
+
?secret_access_key: String,
|
|
54
|
+
?session_token: String,
|
|
55
|
+
?sigv4a_signing_region_set: Array[String],
|
|
56
|
+
?stub_responses: untyped,
|
|
57
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
|
58
|
+
?token_provider: untyped,
|
|
59
|
+
?use_dualstack_endpoint: bool,
|
|
60
|
+
?use_fips_endpoint: bool,
|
|
61
|
+
?validate_params: bool,
|
|
62
|
+
?endpoint_provider: untyped,
|
|
63
|
+
?http_proxy: String,
|
|
64
|
+
?http_open_timeout: (Float | Integer),
|
|
65
|
+
?http_read_timeout: (Float | Integer),
|
|
66
|
+
?http_idle_timeout: (Float | Integer),
|
|
67
|
+
?http_continue_timeout: (Float | Integer),
|
|
68
|
+
?ssl_timeout: (Float | Integer | nil),
|
|
69
|
+
?http_wire_trace: bool,
|
|
70
|
+
?ssl_verify_peer: bool,
|
|
71
|
+
?ssl_ca_bundle: String,
|
|
72
|
+
?ssl_ca_directory: String,
|
|
73
|
+
?ssl_ca_store: String,
|
|
74
|
+
?on_chunk_received: Proc,
|
|
75
|
+
?on_chunk_sent: Proc,
|
|
76
|
+
?raise_response_errors: bool
|
|
77
|
+
) -> instance
|
|
78
|
+
| (?Hash[Symbol, untyped]) -> instance
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
interface _CreateBrandProfileResponseSuccess
|
|
82
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateBrandProfileOutput]
|
|
83
|
+
def brand_profile_id: () -> ::String
|
|
84
|
+
def brand_profile_arn: () -> ::String
|
|
85
|
+
def brand_profile_name: () -> ::String
|
|
86
|
+
def status: () -> ("ACTIVE" | "BLOCKED" | "PAUSED" | "CANCELLED" | "FAILED")
|
|
87
|
+
def deletion_protection_enabled: () -> bool
|
|
88
|
+
def created_at: () -> ::Time
|
|
89
|
+
def updated_at: () -> ::Time
|
|
90
|
+
def attributes_created: () -> ::Integer
|
|
91
|
+
end
|
|
92
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#create_brand_profile-instance_method
|
|
93
|
+
def create_brand_profile: (
|
|
94
|
+
brand_profile_name: ::String,
|
|
95
|
+
?client_token: ::String,
|
|
96
|
+
?deletion_protection_enabled: bool,
|
|
97
|
+
?tags: Array[
|
|
98
|
+
{
|
|
99
|
+
key: ::String,
|
|
100
|
+
value: ::String
|
|
101
|
+
}
|
|
102
|
+
]
|
|
103
|
+
) -> _CreateBrandProfileResponseSuccess
|
|
104
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBrandProfileResponseSuccess
|
|
105
|
+
|
|
106
|
+
interface _CreateBrandProfileAttributesResponseSuccess
|
|
107
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateBrandProfileAttributesOutput]
|
|
108
|
+
def attributes: () -> ::Array[Types::BrandProfileAttributeOutput]
|
|
109
|
+
end
|
|
110
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#create_brand_profile_attributes-instance_method
|
|
111
|
+
def create_brand_profile_attributes: (
|
|
112
|
+
brand_profile_id: ::String,
|
|
113
|
+
attributes: Array[
|
|
114
|
+
{
|
|
115
|
+
attribute_name: ::String,
|
|
116
|
+
attribute_type: ("TEXT" | "IMAGE" | "DOCUMENT"),
|
|
117
|
+
attribute_value: ::String?,
|
|
118
|
+
attachment_body: ::String?,
|
|
119
|
+
description: ::String?,
|
|
120
|
+
category: ::String?
|
|
121
|
+
}
|
|
122
|
+
],
|
|
123
|
+
?client_token: ::String
|
|
124
|
+
) -> _CreateBrandProfileAttributesResponseSuccess
|
|
125
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBrandProfileAttributesResponseSuccess
|
|
126
|
+
|
|
127
|
+
interface _CreateBrandProfileFromRegistrationResponseSuccess
|
|
128
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateBrandProfileFromRegistrationOutput]
|
|
129
|
+
def results: () -> ::Array[Types::JobResult]
|
|
130
|
+
end
|
|
131
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#create_brand_profile_from_registration-instance_method
|
|
132
|
+
def create_brand_profile_from_registration: (
|
|
133
|
+
registration_id: ::String,
|
|
134
|
+
brand_profile_name: ::String,
|
|
135
|
+
?smart_match: bool,
|
|
136
|
+
?tags: Array[
|
|
137
|
+
{
|
|
138
|
+
key: ::String,
|
|
139
|
+
value: ::String
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
?client_token: ::String
|
|
143
|
+
) -> _CreateBrandProfileFromRegistrationResponseSuccess
|
|
144
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBrandProfileFromRegistrationResponseSuccess
|
|
145
|
+
|
|
146
|
+
interface _CreateNotifyCodeConfigurationResponseSuccess
|
|
147
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateNotifyCodeConfigurationOutput]
|
|
148
|
+
def notify_code_configuration: () -> Types::NotifyCodeConfiguration
|
|
149
|
+
end
|
|
150
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#create_notify_code_configuration-instance_method
|
|
151
|
+
def create_notify_code_configuration: (
|
|
152
|
+
notify_code_configuration_name: ::String,
|
|
153
|
+
?code_configuration_parameters: {
|
|
154
|
+
code_type: ("NUMERIC" | "ALPHA" | "ALPHANUMERIC")?,
|
|
155
|
+
code_length: ::Integer?,
|
|
156
|
+
validity_period_minutes: ::Integer?,
|
|
157
|
+
max_attempts: ::Integer?
|
|
158
|
+
},
|
|
159
|
+
?channel_parameters: Params::channel_parameters,
|
|
160
|
+
?deletion_protection_enabled: bool,
|
|
161
|
+
?client_token: ::String,
|
|
162
|
+
?tags: Array[
|
|
163
|
+
{
|
|
164
|
+
key: ::String,
|
|
165
|
+
value: ::String
|
|
166
|
+
}
|
|
167
|
+
]
|
|
168
|
+
) -> _CreateNotifyCodeConfigurationResponseSuccess
|
|
169
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateNotifyCodeConfigurationResponseSuccess
|
|
170
|
+
|
|
171
|
+
interface _CreateRegistrationsFromBrandProfileResponseSuccess
|
|
172
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateRegistrationsFromBrandProfileOutput]
|
|
173
|
+
def results: () -> ::Array[Types::JobResult]
|
|
174
|
+
end
|
|
175
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#create_registrations_from_brand_profile-instance_method
|
|
176
|
+
def create_registrations_from_brand_profile: (
|
|
177
|
+
brand_profile_id: ::String,
|
|
178
|
+
registration_types: Array[::String],
|
|
179
|
+
?smart_match: bool,
|
|
180
|
+
?client_token: ::String
|
|
181
|
+
) -> _CreateRegistrationsFromBrandProfileResponseSuccess
|
|
182
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRegistrationsFromBrandProfileResponseSuccess
|
|
183
|
+
|
|
184
|
+
interface _DeleteBrandProfileResponseSuccess
|
|
185
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBrandProfileOutput]
|
|
186
|
+
def brand_profile_id: () -> ::String
|
|
187
|
+
def brand_profile_arn: () -> ::String
|
|
188
|
+
end
|
|
189
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#delete_brand_profile-instance_method
|
|
190
|
+
def delete_brand_profile: (
|
|
191
|
+
brand_profile_id: ::String
|
|
192
|
+
) -> _DeleteBrandProfileResponseSuccess
|
|
193
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBrandProfileResponseSuccess
|
|
194
|
+
|
|
195
|
+
interface _DeleteBrandProfileAttributeResponseSuccess
|
|
196
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBrandProfileAttributeOutput]
|
|
197
|
+
def brand_profile_id: () -> ::String
|
|
198
|
+
def attribute_name: () -> ::String
|
|
199
|
+
end
|
|
200
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#delete_brand_profile_attribute-instance_method
|
|
201
|
+
def delete_brand_profile_attribute: (
|
|
202
|
+
brand_profile_id: ::String,
|
|
203
|
+
attribute_name: ::String
|
|
204
|
+
) -> _DeleteBrandProfileAttributeResponseSuccess
|
|
205
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBrandProfileAttributeResponseSuccess
|
|
206
|
+
|
|
207
|
+
interface _DeleteNotifyCodeConfigurationResponseSuccess
|
|
208
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteNotifyCodeConfigurationOutput]
|
|
209
|
+
end
|
|
210
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#delete_notify_code_configuration-instance_method
|
|
211
|
+
def delete_notify_code_configuration: (
|
|
212
|
+
notify_code_configuration_id: ::String
|
|
213
|
+
) -> _DeleteNotifyCodeConfigurationResponseSuccess
|
|
214
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteNotifyCodeConfigurationResponseSuccess
|
|
215
|
+
|
|
216
|
+
interface _GetBrandProfileResponseSuccess
|
|
217
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetBrandProfileOutput]
|
|
218
|
+
def brand_profile_id: () -> ::String
|
|
219
|
+
def brand_profile_arn: () -> ::String
|
|
220
|
+
def brand_profile_name: () -> ::String
|
|
221
|
+
def status: () -> ("ACTIVE" | "BLOCKED" | "PAUSED" | "CANCELLED" | "FAILED")
|
|
222
|
+
def deletion_protection_enabled: () -> bool
|
|
223
|
+
def created_at: () -> ::Time
|
|
224
|
+
def updated_at: () -> ::Time
|
|
225
|
+
end
|
|
226
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#get_brand_profile-instance_method
|
|
227
|
+
def get_brand_profile: (
|
|
228
|
+
brand_profile_id: ::String
|
|
229
|
+
) -> _GetBrandProfileResponseSuccess
|
|
230
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBrandProfileResponseSuccess
|
|
231
|
+
|
|
232
|
+
interface _GetBrandProfileAttributeResponseSuccess
|
|
233
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetBrandProfileAttributeOutput]
|
|
234
|
+
def attribute_name: () -> ::String
|
|
235
|
+
def attribute_type: () -> ("TEXT" | "IMAGE" | "DOCUMENT")
|
|
236
|
+
def attribute_value: () -> ::String
|
|
237
|
+
def description: () -> ::String
|
|
238
|
+
def category: () -> ::String
|
|
239
|
+
def media_content_type: () -> ::String
|
|
240
|
+
def media_size_bytes: () -> ::Integer
|
|
241
|
+
def media_download_url: () -> ::String
|
|
242
|
+
def created_at: () -> ::Time
|
|
243
|
+
def updated_at: () -> ::Time
|
|
244
|
+
end
|
|
245
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#get_brand_profile_attribute-instance_method
|
|
246
|
+
def get_brand_profile_attribute: (
|
|
247
|
+
brand_profile_id: ::String,
|
|
248
|
+
attribute_name: ::String
|
|
249
|
+
) -> _GetBrandProfileAttributeResponseSuccess
|
|
250
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBrandProfileAttributeResponseSuccess
|
|
251
|
+
|
|
252
|
+
interface _GetJobResponseSuccess
|
|
253
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::Job]
|
|
254
|
+
def job_id: () -> ::String
|
|
255
|
+
def status: () -> ("SUCCESS" | "PROCESSING" | "FAILED")
|
|
256
|
+
def operation_type: () -> ::String
|
|
257
|
+
def created_at: () -> ::Time
|
|
258
|
+
def updated_at: () -> ::Time
|
|
259
|
+
def brand_profile_id: () -> ::String
|
|
260
|
+
def error_code: () -> ::String
|
|
261
|
+
def error_message: () -> ::String
|
|
262
|
+
def resources: () -> ::Array[Types::JobResource]
|
|
263
|
+
end
|
|
264
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#get_job-instance_method
|
|
265
|
+
def get_job: (
|
|
266
|
+
job_id: ::String
|
|
267
|
+
) -> _GetJobResponseSuccess
|
|
268
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetJobResponseSuccess
|
|
269
|
+
|
|
270
|
+
interface _GetNotifyCodeConfigurationResponseSuccess
|
|
271
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetNotifyCodeConfigurationOutput]
|
|
272
|
+
def notify_code_configuration: () -> Types::NotifyCodeConfiguration
|
|
273
|
+
end
|
|
274
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#get_notify_code_configuration-instance_method
|
|
275
|
+
def get_notify_code_configuration: (
|
|
276
|
+
notify_code_configuration_id: ::String
|
|
277
|
+
) -> _GetNotifyCodeConfigurationResponseSuccess
|
|
278
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetNotifyCodeConfigurationResponseSuccess
|
|
279
|
+
|
|
280
|
+
interface _ListBrandProfileAttributesResponseSuccess
|
|
281
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListBrandProfileAttributesOutput]
|
|
282
|
+
def brand_profile_attributes: () -> ::Array[Types::BrandProfileAttributeSummary]
|
|
283
|
+
def next_token: () -> ::String
|
|
284
|
+
end
|
|
285
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_brand_profile_attributes-instance_method
|
|
286
|
+
def list_brand_profile_attributes: (
|
|
287
|
+
brand_profile_id: ::String,
|
|
288
|
+
?next_token: ::String,
|
|
289
|
+
?max_results: ::Integer
|
|
290
|
+
) -> _ListBrandProfileAttributesResponseSuccess
|
|
291
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBrandProfileAttributesResponseSuccess
|
|
292
|
+
|
|
293
|
+
interface _ListBrandProfilesResponseSuccess
|
|
294
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListBrandProfilesOutput]
|
|
295
|
+
def brand_profiles: () -> ::Array[Types::BrandProfileInfo]
|
|
296
|
+
def next_token: () -> ::String
|
|
297
|
+
end
|
|
298
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_brand_profiles-instance_method
|
|
299
|
+
def list_brand_profiles: (
|
|
300
|
+
?next_token: ::String,
|
|
301
|
+
?max_results: ::Integer
|
|
302
|
+
) -> _ListBrandProfilesResponseSuccess
|
|
303
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBrandProfilesResponseSuccess
|
|
304
|
+
|
|
305
|
+
interface _ListJobsResponseSuccess
|
|
306
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListJobsOutput]
|
|
307
|
+
def jobs: () -> ::Array[Types::JobSummary]
|
|
308
|
+
def next_token: () -> ::String
|
|
309
|
+
end
|
|
310
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_jobs-instance_method
|
|
311
|
+
def list_jobs: (
|
|
312
|
+
?max_results: ::Integer,
|
|
313
|
+
?next_token: ::String,
|
|
314
|
+
?status: ("SUCCESS" | "PROCESSING" | "FAILED"),
|
|
315
|
+
?brand_profile_id: ::String,
|
|
316
|
+
?operation_type: ::String
|
|
317
|
+
) -> _ListJobsResponseSuccess
|
|
318
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListJobsResponseSuccess
|
|
319
|
+
|
|
320
|
+
interface _ListNotifyCodeConfigurationsResponseSuccess
|
|
321
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListNotifyCodeConfigurationsOutput]
|
|
322
|
+
def notify_code_configurations: () -> ::Array[Types::NotifyCodeConfiguration]
|
|
323
|
+
def next_token: () -> ::String
|
|
324
|
+
end
|
|
325
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_notify_code_configurations-instance_method
|
|
326
|
+
def list_notify_code_configurations: (
|
|
327
|
+
?max_results: ::Integer,
|
|
328
|
+
?next_token: ::String
|
|
329
|
+
) -> _ListNotifyCodeConfigurationsResponseSuccess
|
|
330
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListNotifyCodeConfigurationsResponseSuccess
|
|
331
|
+
|
|
332
|
+
interface _ListRegistrationsFromBrandProfileResponseSuccess
|
|
333
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListRegistrationsFromBrandProfileOutput]
|
|
334
|
+
def registration_associations: () -> ::Array[Types::RegistrationAssociationSummary]
|
|
335
|
+
def next_token: () -> ::String
|
|
336
|
+
end
|
|
337
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_registrations_from_brand_profile-instance_method
|
|
338
|
+
def list_registrations_from_brand_profile: (
|
|
339
|
+
brand_profile_id: ::String,
|
|
340
|
+
?max_results: ::Integer,
|
|
341
|
+
?next_token: ::String
|
|
342
|
+
) -> _ListRegistrationsFromBrandProfileResponseSuccess
|
|
343
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRegistrationsFromBrandProfileResponseSuccess
|
|
344
|
+
|
|
345
|
+
interface _ListTagsForResourceResponseSuccess
|
|
346
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
|
|
347
|
+
def tags: () -> ::Array[Types::Tag]
|
|
348
|
+
end
|
|
349
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#list_tags_for_resource-instance_method
|
|
350
|
+
def list_tags_for_resource: (
|
|
351
|
+
resource_arn: ::String
|
|
352
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
353
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
354
|
+
|
|
355
|
+
interface _SendNotifyCodeVerificationResponseSuccess
|
|
356
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendNotifyCodeVerificationOutput]
|
|
357
|
+
def verification_id: () -> ::String
|
|
358
|
+
def message_id: () -> ::String
|
|
359
|
+
end
|
|
360
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#send_notify_code_verification-instance_method
|
|
361
|
+
def send_notify_code_verification: (
|
|
362
|
+
channel: ("TEXT" | "VOICE" | "WHATSAPP"),
|
|
363
|
+
destination_identity: ::String,
|
|
364
|
+
origination_identity: ::String,
|
|
365
|
+
?notify_code_configuration: ::String,
|
|
366
|
+
?override_channel_parameters: Params::channel_parameters,
|
|
367
|
+
?override_code_configuration_parameters: {
|
|
368
|
+
code_type: ("NUMERIC" | "ALPHA" | "ALPHANUMERIC")?,
|
|
369
|
+
code_length: ::Integer?,
|
|
370
|
+
validity_period_minutes: ::Integer?,
|
|
371
|
+
max_attempts: ::Integer?
|
|
372
|
+
},
|
|
373
|
+
?configuration_set_name: ::String,
|
|
374
|
+
?context: Hash[::String, ::String],
|
|
375
|
+
?reference_id: ::String
|
|
376
|
+
) -> _SendNotifyCodeVerificationResponseSuccess
|
|
377
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendNotifyCodeVerificationResponseSuccess
|
|
378
|
+
|
|
379
|
+
interface _TagResourceResponseSuccess
|
|
380
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
|
|
381
|
+
end
|
|
382
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#tag_resource-instance_method
|
|
383
|
+
def tag_resource: (
|
|
384
|
+
resource_arn: ::String,
|
|
385
|
+
tags: Array[
|
|
386
|
+
{
|
|
387
|
+
key: ::String,
|
|
388
|
+
value: ::String
|
|
389
|
+
}
|
|
390
|
+
]
|
|
391
|
+
) -> _TagResourceResponseSuccess
|
|
392
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
|
393
|
+
|
|
394
|
+
interface _UntagResourceResponseSuccess
|
|
395
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceOutput]
|
|
396
|
+
end
|
|
397
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#untag_resource-instance_method
|
|
398
|
+
def untag_resource: (
|
|
399
|
+
resource_arn: ::String,
|
|
400
|
+
tag_keys: Array[::String]
|
|
401
|
+
) -> _UntagResourceResponseSuccess
|
|
402
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
|
403
|
+
|
|
404
|
+
interface _UpdateBrandProfileResponseSuccess
|
|
405
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBrandProfileOutput]
|
|
406
|
+
def brand_profile_id: () -> ::String
|
|
407
|
+
def brand_profile_arn: () -> ::String
|
|
408
|
+
def brand_profile_name: () -> ::String
|
|
409
|
+
def status: () -> ("ACTIVE" | "BLOCKED" | "PAUSED" | "CANCELLED" | "FAILED")
|
|
410
|
+
def deletion_protection_enabled: () -> bool
|
|
411
|
+
def created_at: () -> ::Time
|
|
412
|
+
def updated_at: () -> ::Time
|
|
413
|
+
end
|
|
414
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#update_brand_profile-instance_method
|
|
415
|
+
def update_brand_profile: (
|
|
416
|
+
brand_profile_id: ::String,
|
|
417
|
+
?brand_profile_name: ::String,
|
|
418
|
+
?deletion_protection_enabled: bool
|
|
419
|
+
) -> _UpdateBrandProfileResponseSuccess
|
|
420
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBrandProfileResponseSuccess
|
|
421
|
+
|
|
422
|
+
interface _UpdateBrandProfileAttributeResponseSuccess
|
|
423
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBrandProfileAttributeOutput]
|
|
424
|
+
def attribute_name: () -> ::String
|
|
425
|
+
def attribute_type: () -> ("TEXT" | "IMAGE" | "DOCUMENT")
|
|
426
|
+
def attribute_value: () -> ::String
|
|
427
|
+
def description: () -> ::String
|
|
428
|
+
def category: () -> ::String
|
|
429
|
+
def media_content_type: () -> ::String
|
|
430
|
+
def media_size_bytes: () -> ::Integer
|
|
431
|
+
def created_at: () -> ::Time
|
|
432
|
+
def updated_at: () -> ::Time
|
|
433
|
+
end
|
|
434
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#update_brand_profile_attribute-instance_method
|
|
435
|
+
def update_brand_profile_attribute: (
|
|
436
|
+
brand_profile_id: ::String,
|
|
437
|
+
attribute_name: ::String,
|
|
438
|
+
?attribute_value: ::String,
|
|
439
|
+
?attachment_body: ::String,
|
|
440
|
+
?description: ::String,
|
|
441
|
+
?category: ::String
|
|
442
|
+
) -> _UpdateBrandProfileAttributeResponseSuccess
|
|
443
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBrandProfileAttributeResponseSuccess
|
|
444
|
+
|
|
445
|
+
interface _UpdateBrandProfileFromRegistrationResponseSuccess
|
|
446
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBrandProfileFromRegistrationOutput]
|
|
447
|
+
def results: () -> ::Array[Types::JobResult]
|
|
448
|
+
end
|
|
449
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#update_brand_profile_from_registration-instance_method
|
|
450
|
+
def update_brand_profile_from_registration: (
|
|
451
|
+
brand_profile_id: ::String,
|
|
452
|
+
registration_id: ::String,
|
|
453
|
+
?smart_match: bool,
|
|
454
|
+
?on_attribute_conflict: ("REPLACE" | "PRESERVE"),
|
|
455
|
+
?client_token: ::String
|
|
456
|
+
) -> _UpdateBrandProfileFromRegistrationResponseSuccess
|
|
457
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBrandProfileFromRegistrationResponseSuccess
|
|
458
|
+
|
|
459
|
+
interface _UpdateNotifyCodeConfigurationResponseSuccess
|
|
460
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateNotifyCodeConfigurationOutput]
|
|
461
|
+
def notify_code_configuration: () -> Types::NotifyCodeConfiguration
|
|
462
|
+
end
|
|
463
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#update_notify_code_configuration-instance_method
|
|
464
|
+
def update_notify_code_configuration: (
|
|
465
|
+
notify_code_configuration_id: ::String,
|
|
466
|
+
?notify_code_configuration_name: ::String,
|
|
467
|
+
?code_configuration_parameters: {
|
|
468
|
+
code_type: ("NUMERIC" | "ALPHA" | "ALPHANUMERIC")?,
|
|
469
|
+
code_length: ::Integer?,
|
|
470
|
+
validity_period_minutes: ::Integer?,
|
|
471
|
+
max_attempts: ::Integer?
|
|
472
|
+
},
|
|
473
|
+
?channel_parameters: {
|
|
474
|
+
text: {
|
|
475
|
+
inline_template_body: ::String?,
|
|
476
|
+
destination_country_parameters: Hash[::String, ::String]?
|
|
477
|
+
}?,
|
|
478
|
+
voice: {
|
|
479
|
+
inline_template_body: ::String?,
|
|
480
|
+
language_code: ::String?,
|
|
481
|
+
voice_id: ::String?,
|
|
482
|
+
voice_message_body_text_type: ("TEXT" | "SSML")?
|
|
483
|
+
}?,
|
|
484
|
+
notify: {
|
|
485
|
+
notify_template_id: ::String?,
|
|
486
|
+
voice_id: ::String?
|
|
487
|
+
}?,
|
|
488
|
+
whats_app: {
|
|
489
|
+
whats_app_template_name: ::String?,
|
|
490
|
+
language_code: ::String?
|
|
491
|
+
}?
|
|
492
|
+
},
|
|
493
|
+
?deletion_protection_enabled: bool
|
|
494
|
+
) -> _UpdateNotifyCodeConfigurationResponseSuccess
|
|
495
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateNotifyCodeConfigurationResponseSuccess
|
|
496
|
+
|
|
497
|
+
interface _UpdateRegistrationsFromBrandProfileResponseSuccess
|
|
498
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateRegistrationsFromBrandProfileOutput]
|
|
499
|
+
def results: () -> ::Array[Types::JobResult]
|
|
500
|
+
end
|
|
501
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#update_registrations_from_brand_profile-instance_method
|
|
502
|
+
def update_registrations_from_brand_profile: (
|
|
503
|
+
brand_profile_id: ::String,
|
|
504
|
+
registration_ids: Array[::String],
|
|
505
|
+
?smart_match: bool,
|
|
506
|
+
?on_attribute_conflict: ("REPLACE" | "PRESERVE"),
|
|
507
|
+
?client_token: ::String
|
|
508
|
+
) -> _UpdateRegistrationsFromBrandProfileResponseSuccess
|
|
509
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRegistrationsFromBrandProfileResponseSuccess
|
|
510
|
+
|
|
511
|
+
interface _ValidateNotifyCodeVerificationResponseSuccess
|
|
512
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ValidateNotifyCodeVerificationOutput]
|
|
513
|
+
def status: () -> ("VALID" | "INVALID")
|
|
514
|
+
end
|
|
515
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#validate_notify_code_verification-instance_method
|
|
516
|
+
def validate_notify_code_verification: (
|
|
517
|
+
destination_identity: ::String,
|
|
518
|
+
?reference_id: ::String,
|
|
519
|
+
code: ::String
|
|
520
|
+
) -> _ValidateNotifyCodeVerificationResponseSuccess
|
|
521
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ValidateNotifyCodeVerificationResponseSuccess
|
|
522
|
+
|
|
523
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EndUserMessaging/Client.html#wait_until-instance_method
|
|
524
|
+
def wait_until: (:brand_profile_active waiter_name,
|
|
525
|
+
brand_profile_id: ::String
|
|
526
|
+
) -> Client::_GetBrandProfileResponseSuccess
|
|
527
|
+
| (:brand_profile_active waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetBrandProfileResponseSuccess
|
|
528
|
+
| (:job_success waiter_name,
|
|
529
|
+
job_id: ::String
|
|
530
|
+
) -> Client::_GetJobResponseSuccess
|
|
531
|
+
| (:job_success waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetJobResponseSuccess
|
|
532
|
+
end
|
|
533
|
+
end
|
|
534
|
+
end
|
|
535
|
+
|
data/sig/errors.rbs
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
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 EndUserMessaging
|
|
10
|
+
module Errors
|
|
11
|
+
class ServiceError < ::Aws::Errors::ServiceError
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
class AccessDeniedException < ::Aws::Errors::ServiceError
|
|
15
|
+
def message: () -> ::String
|
|
16
|
+
end
|
|
17
|
+
class ConflictException < ::Aws::Errors::ServiceError
|
|
18
|
+
def message: () -> ::String
|
|
19
|
+
def resource_id: () -> ::String
|
|
20
|
+
def resource_type: () -> ::String
|
|
21
|
+
end
|
|
22
|
+
class InternalServerException < ::Aws::Errors::ServiceError
|
|
23
|
+
def message: () -> ::String
|
|
24
|
+
end
|
|
25
|
+
class ResourceNotFoundException < ::Aws::Errors::ServiceError
|
|
26
|
+
def message: () -> ::String
|
|
27
|
+
def resource_id: () -> ::String
|
|
28
|
+
def resource_type: () -> ::String
|
|
29
|
+
end
|
|
30
|
+
class ServiceQuotaExceededException < ::Aws::Errors::ServiceError
|
|
31
|
+
def message: () -> ::String
|
|
32
|
+
end
|
|
33
|
+
class ThrottlingException < ::Aws::Errors::ServiceError
|
|
34
|
+
def message: () -> ::String
|
|
35
|
+
end
|
|
36
|
+
class ValidationException < ::Aws::Errors::ServiceError
|
|
37
|
+
def message: () -> ::String
|
|
38
|
+
def field_list: () -> ::String
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
data/sig/params.rbs
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
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 EndUserMessaging
|
|
10
|
+
module Params
|
|
11
|
+
type channel_parameters = {
|
|
12
|
+
text: {
|
|
13
|
+
inline_template_body: ::String?,
|
|
14
|
+
destination_country_parameters: Hash[::String, ::String]?
|
|
15
|
+
}?,
|
|
16
|
+
voice: {
|
|
17
|
+
inline_template_body: ::String?,
|
|
18
|
+
language_code: ::String?,
|
|
19
|
+
voice_id: ::String?,
|
|
20
|
+
voice_message_body_text_type: ("TEXT" | "SSML")?
|
|
21
|
+
}?,
|
|
22
|
+
notify: {
|
|
23
|
+
notify_template_id: ::String?,
|
|
24
|
+
voice_id: ::String?
|
|
25
|
+
}?,
|
|
26
|
+
whats_app: {
|
|
27
|
+
whats_app_template_name: ::String?,
|
|
28
|
+
language_code: ::String?
|
|
29
|
+
}?
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|