aws-sdk-socialmessaging 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.
@@ -0,0 +1,61 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ Aws::Plugins::GlobalConfiguration.add_identifier(:socialmessaging)
15
+
16
+ # This module provides support for AWS End User Messaging Social. This module is available in the
17
+ # `aws-sdk-socialmessaging` gem.
18
+ #
19
+ # # Client
20
+ #
21
+ # The {Client} class provides one method for each API operation. Operation
22
+ # methods each accept a hash of request parameters and return a response
23
+ # structure.
24
+ #
25
+ # social_messaging = Aws::SocialMessaging::Client.new
26
+ # resp = social_messaging.associate_whats_app_business_account(params)
27
+ #
28
+ # See {Client} for more information.
29
+ #
30
+ # # Errors
31
+ #
32
+ # Errors returned from AWS End User Messaging Social are defined in the
33
+ # {Errors} module and all extend {Errors::ServiceError}.
34
+ #
35
+ # begin
36
+ # # do stuff
37
+ # rescue Aws::SocialMessaging::Errors::ServiceError
38
+ # # rescues all AWS End User Messaging Social API errors
39
+ # end
40
+ #
41
+ # See {Errors} for more information.
42
+ #
43
+ # @!group service
44
+ module Aws::SocialMessaging
45
+ autoload :Types, 'aws-sdk-socialmessaging/types'
46
+ autoload :ClientApi, 'aws-sdk-socialmessaging/client_api'
47
+ module Plugins
48
+ autoload :Endpoints, 'aws-sdk-socialmessaging/plugins/endpoints.rb'
49
+ end
50
+ autoload :Client, 'aws-sdk-socialmessaging/client'
51
+ autoload :Errors, 'aws-sdk-socialmessaging/errors'
52
+ autoload :Resource, 'aws-sdk-socialmessaging/resource'
53
+ autoload :EndpointParameters, 'aws-sdk-socialmessaging/endpoint_parameters'
54
+ autoload :EndpointProvider, 'aws-sdk-socialmessaging/endpoint_provider'
55
+ autoload :Endpoints, 'aws-sdk-socialmessaging/endpoints'
56
+
57
+ GEM_VERSION = '1.0.0'
58
+
59
+ end
60
+
61
+ require_relative 'aws-sdk-socialmessaging/customizations'
data/sig/client.rbs ADDED
@@ -0,0 +1,280 @@
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 SocialMessaging
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/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
+ ?client_side_monitoring: bool,
22
+ ?client_side_monitoring_client_id: String,
23
+ ?client_side_monitoring_host: String,
24
+ ?client_side_monitoring_port: Integer,
25
+ ?client_side_monitoring_publisher: untyped,
26
+ ?convert_params: bool,
27
+ ?correct_clock_skew: bool,
28
+ ?defaults_mode: String,
29
+ ?disable_host_prefix_injection: bool,
30
+ ?disable_request_compression: bool,
31
+ ?endpoint: String,
32
+ ?endpoint_cache_max_entries: Integer,
33
+ ?endpoint_cache_max_threads: Integer,
34
+ ?endpoint_cache_poll_interval: Integer,
35
+ ?endpoint_discovery: bool,
36
+ ?ignore_configured_endpoint_urls: bool,
37
+ ?log_formatter: untyped,
38
+ ?log_level: Symbol,
39
+ ?logger: untyped,
40
+ ?max_attempts: Integer,
41
+ ?profile: String,
42
+ ?request_min_compression_size_bytes: Integer,
43
+ ?retry_backoff: Proc,
44
+ ?retry_base_delay: Float,
45
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
46
+ ?retry_limit: Integer,
47
+ ?retry_max_delay: Integer,
48
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
49
+ ?sdk_ua_app_id: String,
50
+ ?secret_access_key: String,
51
+ ?session_token: String,
52
+ ?sigv4a_signing_region_set: Array[String],
53
+ ?stub_responses: untyped,
54
+ ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
55
+ ?token_provider: untyped,
56
+ ?use_dualstack_endpoint: bool,
57
+ ?use_fips_endpoint: bool,
58
+ ?validate_params: bool,
59
+ ?endpoint_provider: untyped,
60
+ ?http_proxy: String,
61
+ ?http_open_timeout: (Float | Integer),
62
+ ?http_read_timeout: (Float | Integer),
63
+ ?http_idle_timeout: (Float | Integer),
64
+ ?http_continue_timeout: (Float | Integer),
65
+ ?ssl_timeout: (Float | Integer | nil),
66
+ ?http_wire_trace: bool,
67
+ ?ssl_verify_peer: bool,
68
+ ?ssl_ca_bundle: String,
69
+ ?ssl_ca_directory: String,
70
+ ?ssl_ca_store: String,
71
+ ?on_chunk_received: Proc,
72
+ ?on_chunk_sent: Proc,
73
+ ?raise_response_errors: bool
74
+ ) -> instance
75
+ | (?Hash[Symbol, untyped]) -> instance
76
+
77
+
78
+ interface _AssociateWhatsAppBusinessAccountResponseSuccess
79
+ include ::Seahorse::Client::_ResponseSuccess[Types::AssociateWhatsAppBusinessAccountOutput]
80
+ def signup_callback_result: () -> Types::WhatsAppSignupCallbackResult
81
+ def status_code: () -> ::Integer
82
+ end
83
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#associate_whats_app_business_account-instance_method
84
+ def associate_whats_app_business_account: (
85
+ ?signup_callback: {
86
+ access_token: ::String
87
+ },
88
+ ?setup_finalization: {
89
+ associate_in_progress_token: ::String,
90
+ phone_numbers: Array[
91
+ {
92
+ id: ::String,
93
+ two_factor_pin: ::String,
94
+ data_localization_region: ::String?,
95
+ tags: Array[
96
+ {
97
+ key: ::String,
98
+ value: ::String?
99
+ },
100
+ ]?
101
+ },
102
+ ],
103
+ phone_number_parent: ::String?,
104
+ waba: {
105
+ id: ::String?,
106
+ event_destinations: Array[
107
+ {
108
+ event_destination_arn: ::String
109
+ },
110
+ ]?,
111
+ tags: Array[
112
+ {
113
+ key: ::String,
114
+ value: ::String?
115
+ },
116
+ ]?
117
+ }?
118
+ }
119
+ ) -> _AssociateWhatsAppBusinessAccountResponseSuccess
120
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateWhatsAppBusinessAccountResponseSuccess
121
+
122
+ interface _DeleteWhatsAppMessageMediaResponseSuccess
123
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteWhatsAppMessageMediaOutput]
124
+ def success: () -> bool
125
+ end
126
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#delete_whats_app_message_media-instance_method
127
+ def delete_whats_app_message_media: (
128
+ media_id: ::String,
129
+ origination_phone_number_id: ::String
130
+ ) -> _DeleteWhatsAppMessageMediaResponseSuccess
131
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteWhatsAppMessageMediaResponseSuccess
132
+
133
+ interface _DisassociateWhatsAppBusinessAccountResponseSuccess
134
+ include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateWhatsAppBusinessAccountOutput]
135
+ end
136
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#disassociate_whats_app_business_account-instance_method
137
+ def disassociate_whats_app_business_account: (
138
+ id: ::String
139
+ ) -> _DisassociateWhatsAppBusinessAccountResponseSuccess
140
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateWhatsAppBusinessAccountResponseSuccess
141
+
142
+ interface _GetLinkedWhatsAppBusinessAccountResponseSuccess
143
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetLinkedWhatsAppBusinessAccountOutput]
144
+ def account: () -> Types::LinkedWhatsAppBusinessAccount
145
+ end
146
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#get_linked_whats_app_business_account-instance_method
147
+ def get_linked_whats_app_business_account: (
148
+ id: ::String
149
+ ) -> _GetLinkedWhatsAppBusinessAccountResponseSuccess
150
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLinkedWhatsAppBusinessAccountResponseSuccess
151
+
152
+ interface _GetLinkedWhatsAppBusinessAccountPhoneNumberResponseSuccess
153
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput]
154
+ def phone_number: () -> Types::WhatsAppPhoneNumberDetail
155
+ def linked_whats_app_business_account_id: () -> ::String
156
+ end
157
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#get_linked_whats_app_business_account_phone_number-instance_method
158
+ def get_linked_whats_app_business_account_phone_number: (
159
+ id: ::String
160
+ ) -> _GetLinkedWhatsAppBusinessAccountPhoneNumberResponseSuccess
161
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLinkedWhatsAppBusinessAccountPhoneNumberResponseSuccess
162
+
163
+ interface _GetWhatsAppMessageMediaResponseSuccess
164
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetWhatsAppMessageMediaOutput]
165
+ def mime_type: () -> ::String
166
+ def file_size: () -> ::Integer
167
+ end
168
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#get_whats_app_message_media-instance_method
169
+ def get_whats_app_message_media: (
170
+ media_id: ::String,
171
+ origination_phone_number_id: ::String,
172
+ ?metadata_only: bool,
173
+ ?destination_s3_presigned_url: {
174
+ url: ::String,
175
+ headers: Hash[::String, ::String]
176
+ },
177
+ ?destination_s3_file: {
178
+ bucket_name: ::String,
179
+ key: ::String
180
+ }
181
+ ) -> _GetWhatsAppMessageMediaResponseSuccess
182
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetWhatsAppMessageMediaResponseSuccess
183
+
184
+ interface _ListLinkedWhatsAppBusinessAccountsResponseSuccess
185
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListLinkedWhatsAppBusinessAccountsOutput]
186
+ def linked_accounts: () -> ::Array[Types::LinkedWhatsAppBusinessAccountSummary]
187
+ def next_token: () -> ::String
188
+ end
189
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#list_linked_whats_app_business_accounts-instance_method
190
+ def list_linked_whats_app_business_accounts: (
191
+ ?next_token: ::String,
192
+ ?max_results: ::Integer
193
+ ) -> _ListLinkedWhatsAppBusinessAccountsResponseSuccess
194
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListLinkedWhatsAppBusinessAccountsResponseSuccess
195
+
196
+ interface _ListTagsForResourceResponseSuccess
197
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
198
+ def status_code: () -> ::Integer
199
+ def tags: () -> ::Array[Types::Tag]
200
+ end
201
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#list_tags_for_resource-instance_method
202
+ def list_tags_for_resource: (
203
+ resource_arn: ::String
204
+ ) -> _ListTagsForResourceResponseSuccess
205
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
206
+
207
+ interface _PostWhatsAppMessageMediaResponseSuccess
208
+ include ::Seahorse::Client::_ResponseSuccess[Types::PostWhatsAppMessageMediaOutput]
209
+ def media_id: () -> ::String
210
+ end
211
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#post_whats_app_message_media-instance_method
212
+ def post_whats_app_message_media: (
213
+ origination_phone_number_id: ::String,
214
+ ?source_s3_presigned_url: {
215
+ url: ::String,
216
+ headers: Hash[::String, ::String]
217
+ },
218
+ ?source_s3_file: {
219
+ bucket_name: ::String,
220
+ key: ::String
221
+ }
222
+ ) -> _PostWhatsAppMessageMediaResponseSuccess
223
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PostWhatsAppMessageMediaResponseSuccess
224
+
225
+ interface _PutWhatsAppBusinessAccountEventDestinationsResponseSuccess
226
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutWhatsAppBusinessAccountEventDestinationsOutput]
227
+ end
228
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#put_whats_app_business_account_event_destinations-instance_method
229
+ def put_whats_app_business_account_event_destinations: (
230
+ id: ::String,
231
+ event_destinations: Array[
232
+ {
233
+ event_destination_arn: ::String
234
+ },
235
+ ]
236
+ ) -> _PutWhatsAppBusinessAccountEventDestinationsResponseSuccess
237
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutWhatsAppBusinessAccountEventDestinationsResponseSuccess
238
+
239
+ interface _SendWhatsAppMessageResponseSuccess
240
+ include ::Seahorse::Client::_ResponseSuccess[Types::SendWhatsAppMessageOutput]
241
+ def message_id: () -> ::String
242
+ end
243
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#send_whats_app_message-instance_method
244
+ def send_whats_app_message: (
245
+ origination_phone_number_id: ::String,
246
+ message: ::String,
247
+ meta_api_version: ::String
248
+ ) -> _SendWhatsAppMessageResponseSuccess
249
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendWhatsAppMessageResponseSuccess
250
+
251
+ interface _TagResourceResponseSuccess
252
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
253
+ def status_code: () -> ::Integer
254
+ end
255
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#tag_resource-instance_method
256
+ def tag_resource: (
257
+ resource_arn: ::String,
258
+ tags: Array[
259
+ {
260
+ key: ::String,
261
+ value: ::String?
262
+ },
263
+ ]
264
+ ) -> _TagResourceResponseSuccess
265
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
266
+
267
+ interface _UntagResourceResponseSuccess
268
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceOutput]
269
+ def status_code: () -> ::Integer
270
+ end
271
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Client.html#untag_resource-instance_method
272
+ def untag_resource: (
273
+ resource_arn: ::String,
274
+ tag_keys: Array[::String]
275
+ ) -> _UntagResourceResponseSuccess
276
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
277
+ end
278
+ end
279
+ end
280
+
data/sig/errors.rbs ADDED
@@ -0,0 +1,40 @@
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 SocialMessaging
10
+ module Errors
11
+ class ServiceError < ::Aws::Errors::ServiceError
12
+ end
13
+
14
+ class AccessDeniedByMetaException < ::Aws::Errors::ServiceError
15
+ def message: () -> ::String
16
+ end
17
+ class AccessDeniedException < ::Aws::Errors::ServiceError
18
+ def message: () -> ::String
19
+ end
20
+ class DependencyException < ::Aws::Errors::ServiceError
21
+ def message: () -> ::String
22
+ end
23
+ class InternalServiceException < ::Aws::Errors::ServiceError
24
+ def message: () -> ::String
25
+ end
26
+ class InvalidParametersException < ::Aws::Errors::ServiceError
27
+ def message: () -> ::String
28
+ end
29
+ class ResourceNotFoundException < ::Aws::Errors::ServiceError
30
+ def message: () -> ::String
31
+ end
32
+ class ThrottledRequestException < ::Aws::Errors::ServiceError
33
+ def message: () -> ::String
34
+ end
35
+ class ValidationException < ::Aws::Errors::ServiceError
36
+ def message: () -> ::String
37
+ end
38
+ end
39
+ end
40
+ end
data/sig/resource.rbs ADDED
@@ -0,0 +1,82 @@
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 SocialMessaging
10
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Resource.html
11
+ class Resource
12
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SocialMessaging/Resource.html#initialize-instance_method
13
+ def initialize: (
14
+ ?client: Client,
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
+ ?client_side_monitoring: bool,
22
+ ?client_side_monitoring_client_id: String,
23
+ ?client_side_monitoring_host: String,
24
+ ?client_side_monitoring_port: Integer,
25
+ ?client_side_monitoring_publisher: untyped,
26
+ ?convert_params: bool,
27
+ ?correct_clock_skew: bool,
28
+ ?defaults_mode: String,
29
+ ?disable_host_prefix_injection: bool,
30
+ ?disable_request_compression: bool,
31
+ ?endpoint: String,
32
+ ?endpoint_cache_max_entries: Integer,
33
+ ?endpoint_cache_max_threads: Integer,
34
+ ?endpoint_cache_poll_interval: Integer,
35
+ ?endpoint_discovery: bool,
36
+ ?ignore_configured_endpoint_urls: bool,
37
+ ?log_formatter: untyped,
38
+ ?log_level: Symbol,
39
+ ?logger: untyped,
40
+ ?max_attempts: Integer,
41
+ ?profile: String,
42
+ ?request_min_compression_size_bytes: Integer,
43
+ ?retry_backoff: Proc,
44
+ ?retry_base_delay: Float,
45
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
46
+ ?retry_limit: Integer,
47
+ ?retry_max_delay: Integer,
48
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
49
+ ?sdk_ua_app_id: String,
50
+ ?secret_access_key: String,
51
+ ?session_token: String,
52
+ ?sigv4a_signing_region_set: Array[String],
53
+ ?stub_responses: untyped,
54
+ ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
55
+ ?token_provider: untyped,
56
+ ?use_dualstack_endpoint: bool,
57
+ ?use_fips_endpoint: bool,
58
+ ?validate_params: bool,
59
+ ?endpoint_provider: untyped,
60
+ ?http_proxy: String,
61
+ ?http_open_timeout: (Float | Integer),
62
+ ?http_read_timeout: (Float | Integer),
63
+ ?http_idle_timeout: (Float | Integer),
64
+ ?http_continue_timeout: (Float | Integer),
65
+ ?ssl_timeout: (Float | Integer | nil),
66
+ ?http_wire_trace: bool,
67
+ ?ssl_verify_peer: bool,
68
+ ?ssl_ca_bundle: String,
69
+ ?ssl_ca_directory: String,
70
+ ?ssl_ca_store: String,
71
+ ?on_chunk_received: Proc,
72
+ ?on_chunk_sent: Proc,
73
+ ?raise_response_errors: bool
74
+ ) -> void
75
+ | (?Hash[Symbol, untyped]) -> void
76
+
77
+ def client: () -> Client
78
+
79
+
80
+ end
81
+ end
82
+ end