aws-sdk-socialmessaging 1.32.0 → 1.34.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-socialmessaging/client.rb +199 -21
- data/lib/aws-sdk-socialmessaging/client_api.rb +168 -0
- data/lib/aws-sdk-socialmessaging/errors.rb +16 -0
- data/lib/aws-sdk-socialmessaging/types.rb +412 -25
- data/lib/aws-sdk-socialmessaging.rb +1 -1
- data/sig/client.rbs +71 -0
- data/sig/errors.rbs +12 -9
- data/sig/types.rbs +105 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d77698370a733833d014ebf05429e50758b60207fa93ab31b06d5f3893d7fd51
|
|
4
|
+
data.tar.gz: 31493a14ff3181eea4d78a392f9f6807ea39fca91ea4a3b1d0492bd0a49b8d69
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 65a45d9114e35b3cb33023a2302a48639e864feebf91ee332e0efd4b919c81e732c3a84d0e568fd2ce6ed38d44aac237fe95be95861030067ae40c59129c3d89
|
|
7
|
+
data.tar.gz: 41bae593aed418566ee709c5be3db8ef839412782b55284d61b5258cc41bcc1e95fa6bcc749e55c0a29474946ad64e18e08572816504cca9ed615f1bcf9eff41
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.34.0 (2026-10-19)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adding support for WhatsApp Direct Send.
|
|
8
|
+
|
|
9
|
+
1.33.0 (2026-09-17)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Add support for WhatsApp Calling APIs.
|
|
13
|
+
|
|
4
14
|
1.32.0 (2026-09-11)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.34.0
|
|
@@ -620,12 +620,7 @@ module Aws::SocialMessaging
|
|
|
620
620
|
# to clone.
|
|
621
621
|
#
|
|
622
622
|
# @option params [String] :endpoint_uri
|
|
623
|
-
#
|
|
624
|
-
# the Flow's endpoint\_uri and called by Meta directly. When omitted,
|
|
625
|
-
# the Flow has no endpoint (static Flow). Meta only calls the endpoint
|
|
626
|
-
# when the Flow JSON also declares data\_api\_version. To verify that
|
|
627
|
-
# requests originate from Meta, attach your own Meta app via
|
|
628
|
-
# UpdateWhatsAppFlow.
|
|
623
|
+
# The HTTPS endpoint that Meta calls for a data exchange Flow.
|
|
629
624
|
#
|
|
630
625
|
# @return [Types::CreateWhatsAppFlowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
631
626
|
#
|
|
@@ -1003,6 +998,8 @@ module Aws::SocialMessaging
|
|
|
1003
998
|
# resp.account.event_destinations[0].event_destination_arn #=> String
|
|
1004
999
|
# resp.account.event_destinations[0].role_arn #=> String
|
|
1005
1000
|
# resp.account.marketing_messages_onboarding_status #=> String
|
|
1001
|
+
# resp.account.direct_send_enforcement_status #=> String
|
|
1002
|
+
# resp.account.direct_send_enforcement_status_expires_at #=> Time
|
|
1006
1003
|
# resp.account.dataset_id #=> String
|
|
1007
1004
|
# resp.account.phone_numbers #=> Array
|
|
1008
1005
|
# resp.account.phone_numbers[0].arn #=> String
|
|
@@ -1040,6 +1037,7 @@ module Aws::SocialMessaging
|
|
|
1040
1037
|
#
|
|
1041
1038
|
# * {Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput#phone_number #phone_number} => Types::WhatsAppPhoneNumberDetail
|
|
1042
1039
|
# * {Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput#linked_whats_app_business_account_id #linked_whats_app_business_account_id} => String
|
|
1040
|
+
# * {Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput#call_settings #call_settings} => Types::WhatsAppCallSettings
|
|
1043
1041
|
#
|
|
1044
1042
|
# @example Request syntax with placeholder values
|
|
1045
1043
|
#
|
|
@@ -1058,6 +1056,23 @@ module Aws::SocialMessaging
|
|
|
1058
1056
|
# resp.phone_number.quality_rating #=> String
|
|
1059
1057
|
# resp.phone_number.data_localization_region #=> String
|
|
1060
1058
|
# resp.linked_whats_app_business_account_id #=> String
|
|
1059
|
+
# resp.call_settings.call_enabled #=> Boolean
|
|
1060
|
+
# resp.call_settings.call_hours.enabled #=> Boolean
|
|
1061
|
+
# resp.call_settings.call_hours.timezone #=> String
|
|
1062
|
+
# resp.call_settings.call_hours.weekly_operating_hours #=> Array
|
|
1063
|
+
# resp.call_settings.call_hours.weekly_operating_hours[0].day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
|
|
1064
|
+
# resp.call_settings.call_hours.weekly_operating_hours[0].open_time.hours #=> Integer
|
|
1065
|
+
# resp.call_settings.call_hours.weekly_operating_hours[0].open_time.minutes #=> Integer
|
|
1066
|
+
# resp.call_settings.call_hours.weekly_operating_hours[0].close_time.hours #=> Integer
|
|
1067
|
+
# resp.call_settings.call_hours.weekly_operating_hours[0].close_time.minutes #=> Integer
|
|
1068
|
+
# resp.call_settings.call_hours.holiday_schedule #=> Array
|
|
1069
|
+
# resp.call_settings.call_hours.holiday_schedule[0].date #=> String
|
|
1070
|
+
# resp.call_settings.call_hours.holiday_schedule[0].start_time.hours #=> Integer
|
|
1071
|
+
# resp.call_settings.call_hours.holiday_schedule[0].start_time.minutes #=> Integer
|
|
1072
|
+
# resp.call_settings.call_hours.holiday_schedule[0].end_time.hours #=> Integer
|
|
1073
|
+
# resp.call_settings.call_hours.holiday_schedule[0].end_time.minutes #=> Integer
|
|
1074
|
+
# resp.call_settings.call_icon_visibility #=> String
|
|
1075
|
+
# resp.call_settings.callback_permission_status #=> String
|
|
1061
1076
|
#
|
|
1062
1077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccountPhoneNumber AWS API Documentation
|
|
1063
1078
|
#
|
|
@@ -1100,6 +1115,59 @@ module Aws::SocialMessaging
|
|
|
1100
1115
|
req.send_request(options)
|
|
1101
1116
|
end
|
|
1102
1117
|
|
|
1118
|
+
# Retrieves the current calling permission for a WhatsApp end user,
|
|
1119
|
+
# along with the calling actions the business is allowed to take with
|
|
1120
|
+
# that user. Provide the destination phone number or the business-scoped
|
|
1121
|
+
# user ID to identify the end user.
|
|
1122
|
+
#
|
|
1123
|
+
# @option params [required, String] :origination_phone_number_id
|
|
1124
|
+
# The unique identifier of the business phone number for which to
|
|
1125
|
+
# retrieve the calling permission. The phone number identifiers are
|
|
1126
|
+
# formatted as `phone-number-id-01234567890123456789012345678901`.
|
|
1127
|
+
#
|
|
1128
|
+
# @option params [String] :destination_phone_number
|
|
1129
|
+
# The end user's phone number, in E.164 format, for which to retrieve
|
|
1130
|
+
# the calling permission.
|
|
1131
|
+
#
|
|
1132
|
+
# @option params [String] :end_user_bsuid
|
|
1133
|
+
# The business-scoped user identifier (BSUID) of the end user for which
|
|
1134
|
+
# to retrieve the calling permission.
|
|
1135
|
+
#
|
|
1136
|
+
# @return [Types::GetWhatsAppCallPermissionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1137
|
+
#
|
|
1138
|
+
# * {Types::GetWhatsAppCallPermissionOutput#permission #permission} => Types::WhatsAppCallPermission
|
|
1139
|
+
# * {Types::GetWhatsAppCallPermissionOutput#actions #actions} => Array<Types::WhatsAppCallPermissionAction>
|
|
1140
|
+
#
|
|
1141
|
+
# @example Request syntax with placeholder values
|
|
1142
|
+
#
|
|
1143
|
+
# resp = client.get_whats_app_call_permission({
|
|
1144
|
+
# origination_phone_number_id: "WhatsAppPhoneNumberId", # required
|
|
1145
|
+
# destination_phone_number: "WhatsAppDestinationPhoneNumber",
|
|
1146
|
+
# end_user_bsuid: "WhatsAppBusinessScopedUserId",
|
|
1147
|
+
# })
|
|
1148
|
+
#
|
|
1149
|
+
# @example Response structure
|
|
1150
|
+
#
|
|
1151
|
+
# resp.permission.status #=> String
|
|
1152
|
+
# resp.permission.expiration_time #=> Time
|
|
1153
|
+
# resp.actions #=> Array
|
|
1154
|
+
# resp.actions[0].action_name #=> String
|
|
1155
|
+
# resp.actions[0].can_perform_action #=> Boolean
|
|
1156
|
+
# resp.actions[0].limits #=> Array
|
|
1157
|
+
# resp.actions[0].limits[0].time_period #=> String
|
|
1158
|
+
# resp.actions[0].limits[0].max_allowed #=> Integer
|
|
1159
|
+
# resp.actions[0].limits[0].current_usage #=> Integer
|
|
1160
|
+
# resp.actions[0].limits[0].limit_expiration_time #=> Time
|
|
1161
|
+
#
|
|
1162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetWhatsAppCallPermission AWS API Documentation
|
|
1163
|
+
#
|
|
1164
|
+
# @overload get_whats_app_call_permission(params = {})
|
|
1165
|
+
# @param [Hash] params ({})
|
|
1166
|
+
def get_whats_app_call_permission(params = {}, options = {})
|
|
1167
|
+
req = build_request(:get_whats_app_call_permission, params)
|
|
1168
|
+
req.send_request(options)
|
|
1169
|
+
end
|
|
1170
|
+
|
|
1103
1171
|
# Retrieves the metadata and status of a WhatsApp Flow, including
|
|
1104
1172
|
# validation errors, preview information, and health status.
|
|
1105
1173
|
#
|
|
@@ -1356,6 +1424,8 @@ module Aws::SocialMessaging
|
|
|
1356
1424
|
# resp.linked_accounts[0].event_destinations[0].event_destination_arn #=> String
|
|
1357
1425
|
# resp.linked_accounts[0].event_destinations[0].role_arn #=> String
|
|
1358
1426
|
# resp.linked_accounts[0].marketing_messages_onboarding_status #=> String
|
|
1427
|
+
# resp.linked_accounts[0].direct_send_enforcement_status #=> String
|
|
1428
|
+
# resp.linked_accounts[0].direct_send_enforcement_status_expires_at #=> Time
|
|
1359
1429
|
# resp.linked_accounts[0].dataset_id #=> String
|
|
1360
1430
|
# resp.next_token #=> String
|
|
1361
1431
|
#
|
|
@@ -1535,6 +1605,8 @@ module Aws::SocialMessaging
|
|
|
1535
1605
|
# resp.templates[0].template_quality_score #=> String
|
|
1536
1606
|
# resp.templates[0].template_language #=> String
|
|
1537
1607
|
# resp.templates[0].template_category #=> String
|
|
1608
|
+
# resp.templates[0].template_source #=> String
|
|
1609
|
+
# resp.templates[0].correct_category #=> String
|
|
1538
1610
|
# resp.next_token #=> String
|
|
1539
1611
|
#
|
|
1540
1612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppMessageTemplates AWS API Documentation
|
|
@@ -1753,11 +1825,12 @@ module Aws::SocialMessaging
|
|
|
1753
1825
|
# business public key.
|
|
1754
1826
|
#
|
|
1755
1827
|
# @option params [String] :business_public_key
|
|
1756
|
-
# PEM-encoded RSA public key. Mutually exclusive
|
|
1828
|
+
# The PEM-encoded 2048-bit RSA public key to set. Mutually exclusive
|
|
1829
|
+
# with `kmsKeyArn`.
|
|
1757
1830
|
#
|
|
1758
1831
|
# @option params [String] :kms_key_arn
|
|
1759
|
-
#
|
|
1760
|
-
# businessPublicKey
|
|
1832
|
+
# The ARN of a customer managed asymmetric RSA key in Amazon Web
|
|
1833
|
+
# Services KMS. Mutually exclusive with `businessPublicKey`.
|
|
1761
1834
|
#
|
|
1762
1835
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1763
1836
|
#
|
|
@@ -1778,6 +1851,50 @@ module Aws::SocialMessaging
|
|
|
1778
1851
|
req.send_request(options)
|
|
1779
1852
|
end
|
|
1780
1853
|
|
|
1854
|
+
# Sends a WhatsApp calling event, such as connecting or terminating a
|
|
1855
|
+
# call, for a business phone number. This operation passes the event
|
|
1856
|
+
# through to Meta. To use this operation, the origination phone number
|
|
1857
|
+
# must belong to a WhatsApp Business Account that is linked to your
|
|
1858
|
+
# Amazon Web Services account.
|
|
1859
|
+
#
|
|
1860
|
+
# @option params [required, String] :origination_phone_number_id
|
|
1861
|
+
# The unique identifier of the origination phone number for the call.
|
|
1862
|
+
# The phone number identifiers are formatted as
|
|
1863
|
+
# `phone-number-id-01234567890123456789012345678901`. Use
|
|
1864
|
+
# `GetLinkedWhatsAppBusinessAccount` to find a phone number's ID.
|
|
1865
|
+
#
|
|
1866
|
+
# @option params [required, String] :meta_api_version
|
|
1867
|
+
# The version of the Meta Graph API to use for the request.
|
|
1868
|
+
#
|
|
1869
|
+
# @option params [required, String, StringIO, File] :call_event
|
|
1870
|
+
# The call event payload to send, as a JSON blob in the format defined
|
|
1871
|
+
# by the Meta calling API.
|
|
1872
|
+
#
|
|
1873
|
+
# @return [Types::SendWhatsAppCallEventOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1874
|
+
#
|
|
1875
|
+
# * {Types::SendWhatsAppCallEventOutput#call_id #call_id} => String
|
|
1876
|
+
#
|
|
1877
|
+
# @example Request syntax with placeholder values
|
|
1878
|
+
#
|
|
1879
|
+
# resp = client.send_whats_app_call_event({
|
|
1880
|
+
# origination_phone_number_id: "WhatsAppPhoneNumberId", # required
|
|
1881
|
+
# meta_api_version: "String", # required
|
|
1882
|
+
# call_event: "data", # required
|
|
1883
|
+
# })
|
|
1884
|
+
#
|
|
1885
|
+
# @example Response structure
|
|
1886
|
+
#
|
|
1887
|
+
# resp.call_id #=> String
|
|
1888
|
+
#
|
|
1889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/SendWhatsAppCallEvent AWS API Documentation
|
|
1890
|
+
#
|
|
1891
|
+
# @overload send_whats_app_call_event(params = {})
|
|
1892
|
+
# @param [Hash] params ({})
|
|
1893
|
+
def send_whats_app_call_event(params = {}, options = {})
|
|
1894
|
+
req = build_request(:send_whats_app_call_event, params)
|
|
1895
|
+
req.send_request(options)
|
|
1896
|
+
end
|
|
1897
|
+
|
|
1781
1898
|
# Sends a conversion event to Meta's Conversions API for the specified
|
|
1782
1899
|
# WhatsApp Business Account dataset.
|
|
1783
1900
|
#
|
|
@@ -1955,6 +2072,76 @@ module Aws::SocialMessaging
|
|
|
1955
2072
|
req.send_request(options)
|
|
1956
2073
|
end
|
|
1957
2074
|
|
|
2075
|
+
# Updates the calling settings for a linked WhatsApp business phone
|
|
2076
|
+
# number, such as whether calling is enabled and the hours during which
|
|
2077
|
+
# the business accepts calls.
|
|
2078
|
+
#
|
|
2079
|
+
# @option params [required, String] :id
|
|
2080
|
+
# The unique identifier of the phone number to update. The phone number
|
|
2081
|
+
# identifiers are formatted as
|
|
2082
|
+
# `phone-number-id-01234567890123456789012345678901`.
|
|
2083
|
+
#
|
|
2084
|
+
# @option params [required, Types::WhatsAppCallSettings] :call_settings
|
|
2085
|
+
# The calling settings to apply to the phone number.
|
|
2086
|
+
#
|
|
2087
|
+
# @return [Types::UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2088
|
+
#
|
|
2089
|
+
# * {Types::UpdateLinkedWhatsAppBusinessAccountPhoneNumberOutput#phone_number_id #phone_number_id} => String
|
|
2090
|
+
#
|
|
2091
|
+
# @example Request syntax with placeholder values
|
|
2092
|
+
#
|
|
2093
|
+
# resp = client.update_linked_whats_app_business_account_phone_number({
|
|
2094
|
+
# id: "WhatsAppPhoneNumberId", # required
|
|
2095
|
+
# call_settings: { # required
|
|
2096
|
+
# call_enabled: false, # required
|
|
2097
|
+
# call_hours: {
|
|
2098
|
+
# enabled: false, # required
|
|
2099
|
+
# timezone: "IanaTimezone", # required
|
|
2100
|
+
# weekly_operating_hours: [ # required
|
|
2101
|
+
# {
|
|
2102
|
+
# day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
|
|
2103
|
+
# open_time: { # required
|
|
2104
|
+
# hours: 1, # required
|
|
2105
|
+
# minutes: 1, # required
|
|
2106
|
+
# },
|
|
2107
|
+
# close_time: { # required
|
|
2108
|
+
# hours: 1, # required
|
|
2109
|
+
# minutes: 1, # required
|
|
2110
|
+
# },
|
|
2111
|
+
# },
|
|
2112
|
+
# ],
|
|
2113
|
+
# holiday_schedule: [
|
|
2114
|
+
# {
|
|
2115
|
+
# date: "WhatsAppDate", # required
|
|
2116
|
+
# start_time: { # required
|
|
2117
|
+
# hours: 1, # required
|
|
2118
|
+
# minutes: 1, # required
|
|
2119
|
+
# },
|
|
2120
|
+
# end_time: { # required
|
|
2121
|
+
# hours: 1, # required
|
|
2122
|
+
# minutes: 1, # required
|
|
2123
|
+
# },
|
|
2124
|
+
# },
|
|
2125
|
+
# ],
|
|
2126
|
+
# },
|
|
2127
|
+
# call_icon_visibility: "WhatsAppCallIconVisibility",
|
|
2128
|
+
# callback_permission_status: "WhatsAppCallbackPermissionStatus",
|
|
2129
|
+
# },
|
|
2130
|
+
# })
|
|
2131
|
+
#
|
|
2132
|
+
# @example Response structure
|
|
2133
|
+
#
|
|
2134
|
+
# resp.phone_number_id #=> String
|
|
2135
|
+
#
|
|
2136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/UpdateLinkedWhatsAppBusinessAccountPhoneNumber AWS API Documentation
|
|
2137
|
+
#
|
|
2138
|
+
# @overload update_linked_whats_app_business_account_phone_number(params = {})
|
|
2139
|
+
# @param [Hash] params ({})
|
|
2140
|
+
def update_linked_whats_app_business_account_phone_number(params = {}, options = {})
|
|
2141
|
+
req = build_request(:update_linked_whats_app_business_account_phone_number, params)
|
|
2142
|
+
req.send_request(options)
|
|
2143
|
+
end
|
|
2144
|
+
|
|
1958
2145
|
# Updates the metadata of a WhatsApp Flow, such as its name or
|
|
1959
2146
|
# categories. This does not update the Flow JSON definition. Use
|
|
1960
2147
|
# [UpdateWhatsAppFlowAssets][1] to update the Flow JSON.
|
|
@@ -1976,19 +2163,10 @@ module Aws::SocialMessaging
|
|
|
1976
2163
|
# The updated categories for the Flow.
|
|
1977
2164
|
#
|
|
1978
2165
|
# @option params [String] :endpoint_uri
|
|
1979
|
-
#
|
|
1980
|
-
# the Flow's endpoint\_uri and called by Meta directly. When omitted,
|
|
1981
|
-
# the Flow's endpoint is unchanged.
|
|
2166
|
+
# The updated HTTPS endpoint for a data exchange Flow.
|
|
1982
2167
|
#
|
|
1983
2168
|
# @option params [String] :meta_app_id
|
|
1984
|
-
#
|
|
1985
|
-
# requests with the attached app's secret, so attaching your own app is
|
|
1986
|
-
# what enables X-Hub-Signature-256 and flow\_token\_signature
|
|
1987
|
-
# verification at your endpoint. Meta requires the app to be owned by
|
|
1988
|
-
# the same business that owns the WABA. Attaching your own app is
|
|
1989
|
-
# one-way: the service's app cannot be re-attached afterwards. When
|
|
1990
|
-
# omitted, the attached app is unchanged. (Set via update because Meta
|
|
1991
|
-
# ignores application\_id at creation time.)
|
|
2169
|
+
# The ID of the Meta application to attach to the Flow.
|
|
1992
2170
|
#
|
|
1993
2171
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1994
2172
|
#
|
|
@@ -2126,7 +2304,7 @@ module Aws::SocialMessaging
|
|
|
2126
2304
|
tracer: tracer
|
|
2127
2305
|
)
|
|
2128
2306
|
context[:gem_name] = 'aws-sdk-socialmessaging'
|
|
2129
|
-
context[:gem_version] = '1.
|
|
2307
|
+
context[:gem_version] = '1.34.0'
|
|
2130
2308
|
Seahorse::Client::Request.new(handlers, context)
|
|
2131
2309
|
end
|
|
2132
2310
|
|