aws-sdk-socialmessaging 1.9.0 → 1.11.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 +379 -9
- data/lib/aws-sdk-socialmessaging/client_api.rb +343 -0
- data/lib/aws-sdk-socialmessaging/errors.rb +16 -0
- data/lib/aws-sdk-socialmessaging/types.rb +588 -3
- data/lib/aws-sdk-socialmessaging.rb +1 -1
- data/sig/client.rbs +129 -1
- data/sig/errors.rbs +3 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +169 -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: d88618b3d1e8a2164f518ba94e0184977cc670049b668d48e5d7036085d4c444
|
4
|
+
data.tar.gz: 5e724940b75805925809bcbf409ea4391d5325e393f4348d0d21d8b79440bd60
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a94f956ff6cdd8f3d5111fc48c4e23cbe2647e78ca497deaa35d966701003cf5b2cf34c56f9961c5a25b879d556d3d5e9c458e2e084abefe459d4ce06ac6b093
|
7
|
+
data.tar.gz: 1a4239ee09bf796903e33ba36923e560d67145905277cfe3a85d918816bad8bc582921a68defbc5e972a12ca5fddf1f3872ab4db2c65a1680aaef442b6b6f1bd
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.11.0 (2025-07-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces new WhatsApp template management APIs that enable customers to programmatically create and submit templates for approval, monitor approval status, and manage the complete template lifecycle
|
8
|
+
|
9
|
+
1.10.0 (2025-07-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.9.0 (2025-06-02)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.11.0
|
@@ -95,7 +95,7 @@ module Aws::SocialMessaging
|
|
95
95
|
# class name or an instance of a plugin class.
|
96
96
|
#
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
-
# Your AWS credentials. This can be an instance of any one of the
|
98
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
99
99
|
# following classes:
|
100
100
|
#
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
@@ -128,18 +128,23 @@ module Aws::SocialMessaging
|
|
128
128
|
# locations will be searched for credentials:
|
129
129
|
#
|
130
130
|
# * `Aws.config[:credentials]`
|
131
|
+
#
|
131
132
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
133
|
# `:account_id` options.
|
133
|
-
#
|
134
|
-
#
|
134
|
+
#
|
135
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
136
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
137
|
+
#
|
135
138
|
# * `~/.aws/credentials`
|
139
|
+
#
|
136
140
|
# * `~/.aws/config`
|
141
|
+
#
|
137
142
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
138
143
|
# are very aggressive. Construct and pass an instance of
|
139
144
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
140
145
|
# enable retries and extended timeouts. Instance profile credential
|
141
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
142
|
-
# to true
|
146
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
147
|
+
# to `true`.
|
143
148
|
#
|
144
149
|
# @option options [required, String] :region
|
145
150
|
# The AWS region to connect to. The configured `:region` is
|
@@ -167,6 +172,11 @@ module Aws::SocialMessaging
|
|
167
172
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
168
173
|
# not retry instead of sleeping.
|
169
174
|
#
|
175
|
+
# @option options [Array<String>] :auth_scheme_preference
|
176
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
177
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
178
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
179
|
+
#
|
170
180
|
# @option options [Boolean] :client_side_monitoring (false)
|
171
181
|
# When `true`, client-side metrics will be collected for all API requests from
|
172
182
|
# this client.
|
@@ -253,8 +263,8 @@ module Aws::SocialMessaging
|
|
253
263
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
254
264
|
#
|
255
265
|
# @option options [String] :profile ("default")
|
256
|
-
# Used when loading credentials from the shared credentials file
|
257
|
-
#
|
266
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
267
|
+
# When not specified, 'default' is used.
|
258
268
|
#
|
259
269
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
260
270
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
@@ -367,7 +377,7 @@ module Aws::SocialMessaging
|
|
367
377
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
368
378
|
#
|
369
379
|
# @option options [Aws::TokenProvider] :token_provider
|
370
|
-
#
|
380
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
371
381
|
# following classes:
|
372
382
|
#
|
373
383
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
@@ -490,6 +500,7 @@ module Aws::SocialMessaging
|
|
490
500
|
# resp = client.associate_whats_app_business_account({
|
491
501
|
# signup_callback: {
|
492
502
|
# access_token: "WhatsAppSignupCallbackAccessTokenString", # required
|
503
|
+
# callback_url: "WhatsAppSignupCallbackCallbackUrlString",
|
493
504
|
# },
|
494
505
|
# setup_finalization: {
|
495
506
|
# associate_in_progress_token: "AssociateInProgressToken", # required
|
@@ -539,6 +550,7 @@ module Aws::SocialMessaging
|
|
539
550
|
# resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number_name #=> String
|
540
551
|
# resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number #=> String
|
541
552
|
# resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].quality_rating #=> String
|
553
|
+
# resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].data_localization_region #=> String
|
542
554
|
# resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].waba_id #=> String
|
543
555
|
# resp.status_code #=> Integer
|
544
556
|
#
|
@@ -551,6 +563,146 @@ module Aws::SocialMessaging
|
|
551
563
|
req.send_request(options)
|
552
564
|
end
|
553
565
|
|
566
|
+
# Creates a new WhatsApp message template from a custom definition.
|
567
|
+
#
|
568
|
+
# @option params [required, String, StringIO, File] :template_definition
|
569
|
+
# The complete template definition as a JSON blob.
|
570
|
+
#
|
571
|
+
# @option params [required, String] :id
|
572
|
+
# The ID of the WhatsApp Business Account to associate with this
|
573
|
+
# template.
|
574
|
+
#
|
575
|
+
# @return [Types::CreateWhatsAppMessageTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
576
|
+
#
|
577
|
+
# * {Types::CreateWhatsAppMessageTemplateOutput#meta_template_id #meta_template_id} => String
|
578
|
+
# * {Types::CreateWhatsAppMessageTemplateOutput#template_status #template_status} => String
|
579
|
+
# * {Types::CreateWhatsAppMessageTemplateOutput#category #category} => String
|
580
|
+
#
|
581
|
+
# @example Request syntax with placeholder values
|
582
|
+
#
|
583
|
+
# resp = client.create_whats_app_message_template({
|
584
|
+
# template_definition: "data", # required
|
585
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
586
|
+
# })
|
587
|
+
#
|
588
|
+
# @example Response structure
|
589
|
+
#
|
590
|
+
# resp.meta_template_id #=> String
|
591
|
+
# resp.template_status #=> String
|
592
|
+
# resp.category #=> String
|
593
|
+
#
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplate AWS API Documentation
|
595
|
+
#
|
596
|
+
# @overload create_whats_app_message_template(params = {})
|
597
|
+
# @param [Hash] params ({})
|
598
|
+
def create_whats_app_message_template(params = {}, options = {})
|
599
|
+
req = build_request(:create_whats_app_message_template, params)
|
600
|
+
req.send_request(options)
|
601
|
+
end
|
602
|
+
|
603
|
+
# Creates a new WhatsApp message template using a template from Meta's
|
604
|
+
# template library.
|
605
|
+
#
|
606
|
+
# @option params [required, Types::MetaLibraryTemplate] :meta_library_template
|
607
|
+
# The template configuration from Meta's library, including
|
608
|
+
# customizations for buttons and body text.
|
609
|
+
#
|
610
|
+
# @option params [required, String] :id
|
611
|
+
# The ID of the WhatsApp Business Account to associate with this
|
612
|
+
# template.
|
613
|
+
#
|
614
|
+
# @return [Types::CreateWhatsAppMessageTemplateFromLibraryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
615
|
+
#
|
616
|
+
# * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#meta_template_id #meta_template_id} => String
|
617
|
+
# * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#template_status #template_status} => String
|
618
|
+
# * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#category #category} => String
|
619
|
+
#
|
620
|
+
# @example Request syntax with placeholder values
|
621
|
+
#
|
622
|
+
# resp = client.create_whats_app_message_template_from_library({
|
623
|
+
# meta_library_template: { # required
|
624
|
+
# template_name: "MetaTemplateName", # required
|
625
|
+
# library_template_name: "MetaTemplateName", # required
|
626
|
+
# template_category: "MetaTemplateCategory", # required
|
627
|
+
# template_language: "MetaTemplateLanguage", # required
|
628
|
+
# library_template_button_inputs: [
|
629
|
+
# {
|
630
|
+
# type: "ButtonType",
|
631
|
+
# phone_number: "PhoneNumber",
|
632
|
+
# url: {
|
633
|
+
# "MetaUrlWithSuffixExampleKeyString" => "MetaUrlWithSuffixExampleValueString",
|
634
|
+
# },
|
635
|
+
# otp_type: "OtpType",
|
636
|
+
# zero_tap_terms_accepted: false,
|
637
|
+
# supported_apps: [
|
638
|
+
# {
|
639
|
+
# "SupportedAppKeyString" => "SupportedAppValueString",
|
640
|
+
# },
|
641
|
+
# ],
|
642
|
+
# },
|
643
|
+
# ],
|
644
|
+
# library_template_body_inputs: {
|
645
|
+
# add_contact_number: false,
|
646
|
+
# add_learn_more_link: false,
|
647
|
+
# add_security_recommendation: false,
|
648
|
+
# add_track_package_link: false,
|
649
|
+
# code_expiration_minutes: 1,
|
650
|
+
# },
|
651
|
+
# },
|
652
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
653
|
+
# })
|
654
|
+
#
|
655
|
+
# @example Response structure
|
656
|
+
#
|
657
|
+
# resp.meta_template_id #=> String
|
658
|
+
# resp.template_status #=> String
|
659
|
+
# resp.category #=> String
|
660
|
+
#
|
661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplateFromLibrary AWS API Documentation
|
662
|
+
#
|
663
|
+
# @overload create_whats_app_message_template_from_library(params = {})
|
664
|
+
# @param [Hash] params ({})
|
665
|
+
def create_whats_app_message_template_from_library(params = {}, options = {})
|
666
|
+
req = build_request(:create_whats_app_message_template_from_library, params)
|
667
|
+
req.send_request(options)
|
668
|
+
end
|
669
|
+
|
670
|
+
# Uploads media for use in a WhatsApp message template.
|
671
|
+
#
|
672
|
+
# @option params [required, String] :id
|
673
|
+
# The ID of the WhatsApp Business Account associated with this media
|
674
|
+
# upload.
|
675
|
+
#
|
676
|
+
# @option params [Types::S3File] :source_s3_file
|
677
|
+
# Contains information for the S3 bucket that contains media files.
|
678
|
+
#
|
679
|
+
# @return [Types::CreateWhatsAppMessageTemplateMediaOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
680
|
+
#
|
681
|
+
# * {Types::CreateWhatsAppMessageTemplateMediaOutput#meta_header_handle #meta_header_handle} => String
|
682
|
+
#
|
683
|
+
# @example Request syntax with placeholder values
|
684
|
+
#
|
685
|
+
# resp = client.create_whats_app_message_template_media({
|
686
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
687
|
+
# source_s3_file: {
|
688
|
+
# bucket_name: "S3FileBucketNameString", # required
|
689
|
+
# key: "S3FileKeyString", # required
|
690
|
+
# },
|
691
|
+
# })
|
692
|
+
#
|
693
|
+
# @example Response structure
|
694
|
+
#
|
695
|
+
# resp.meta_header_handle #=> String
|
696
|
+
#
|
697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplateMedia AWS API Documentation
|
698
|
+
#
|
699
|
+
# @overload create_whats_app_message_template_media(params = {})
|
700
|
+
# @param [Hash] params ({})
|
701
|
+
def create_whats_app_message_template_media(params = {}, options = {})
|
702
|
+
req = build_request(:create_whats_app_message_template_media, params)
|
703
|
+
req.send_request(options)
|
704
|
+
end
|
705
|
+
|
554
706
|
# Delete a media object from the WhatsApp service. If the object is
|
555
707
|
# still in an Amazon S3 bucket you should delete it from there too.
|
556
708
|
#
|
@@ -596,6 +748,40 @@ module Aws::SocialMessaging
|
|
596
748
|
req.send_request(options)
|
597
749
|
end
|
598
750
|
|
751
|
+
# Deletes a WhatsApp message template.
|
752
|
+
#
|
753
|
+
# @option params [String] :meta_template_id
|
754
|
+
# The numeric ID of the template assigned by Meta.
|
755
|
+
#
|
756
|
+
# @option params [Boolean] :delete_all_languages
|
757
|
+
# If true, deletes all language versions of the template.
|
758
|
+
#
|
759
|
+
# @option params [required, String] :id
|
760
|
+
# The ID of the WhatsApp Business Account associated with this template.
|
761
|
+
#
|
762
|
+
# @option params [required, String] :template_name
|
763
|
+
# The name of the template to delete.
|
764
|
+
#
|
765
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
766
|
+
#
|
767
|
+
# @example Request syntax with placeholder values
|
768
|
+
#
|
769
|
+
# resp = client.delete_whats_app_message_template({
|
770
|
+
# meta_template_id: "MetaTemplateId",
|
771
|
+
# delete_all_languages: false,
|
772
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
773
|
+
# template_name: "MetaTemplateName", # required
|
774
|
+
# })
|
775
|
+
#
|
776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/DeleteWhatsAppMessageTemplate AWS API Documentation
|
777
|
+
#
|
778
|
+
# @overload delete_whats_app_message_template(params = {})
|
779
|
+
# @param [Hash] params ({})
|
780
|
+
def delete_whats_app_message_template(params = {}, options = {})
|
781
|
+
req = build_request(:delete_whats_app_message_template, params)
|
782
|
+
req.send_request(options)
|
783
|
+
end
|
784
|
+
|
599
785
|
# Disassociate a WhatsApp Business Account (WABA) from your Amazon Web
|
600
786
|
# Services account.
|
601
787
|
#
|
@@ -668,6 +854,7 @@ module Aws::SocialMessaging
|
|
668
854
|
# resp.account.phone_numbers[0].display_phone_number_name #=> String
|
669
855
|
# resp.account.phone_numbers[0].display_phone_number #=> String
|
670
856
|
# resp.account.phone_numbers[0].quality_rating #=> String
|
857
|
+
# resp.account.phone_numbers[0].data_localization_region #=> String
|
671
858
|
#
|
672
859
|
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccount AWS API Documentation
|
673
860
|
#
|
@@ -711,6 +898,7 @@ module Aws::SocialMessaging
|
|
711
898
|
# resp.phone_number.display_phone_number_name #=> String
|
712
899
|
# resp.phone_number.display_phone_number #=> String
|
713
900
|
# resp.phone_number.quality_rating #=> String
|
901
|
+
# resp.phone_number.data_localization_region #=> String
|
714
902
|
# resp.linked_whats_app_business_account_id #=> String
|
715
903
|
#
|
716
904
|
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccountPhoneNumber AWS API Documentation
|
@@ -787,6 +975,38 @@ module Aws::SocialMessaging
|
|
787
975
|
req.send_request(options)
|
788
976
|
end
|
789
977
|
|
978
|
+
# Retrieves a specific WhatsApp message template.
|
979
|
+
#
|
980
|
+
# @option params [required, String] :meta_template_id
|
981
|
+
# The numeric ID of the template assigned by Meta.
|
982
|
+
#
|
983
|
+
# @option params [required, String] :id
|
984
|
+
# The ID of the WhatsApp Business Account associated with this template.
|
985
|
+
#
|
986
|
+
# @return [Types::GetWhatsAppMessageTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
987
|
+
#
|
988
|
+
# * {Types::GetWhatsAppMessageTemplateOutput#template #template} => String
|
989
|
+
#
|
990
|
+
# @example Request syntax with placeholder values
|
991
|
+
#
|
992
|
+
# resp = client.get_whats_app_message_template({
|
993
|
+
# meta_template_id: "MetaTemplateId", # required
|
994
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
995
|
+
# })
|
996
|
+
#
|
997
|
+
# @example Response structure
|
998
|
+
#
|
999
|
+
# resp.template #=> String
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetWhatsAppMessageTemplate AWS API Documentation
|
1002
|
+
#
|
1003
|
+
# @overload get_whats_app_message_template(params = {})
|
1004
|
+
# @param [Hash] params ({})
|
1005
|
+
def get_whats_app_message_template(params = {}, options = {})
|
1006
|
+
req = build_request(:get_whats_app_message_template, params)
|
1007
|
+
req.send_request(options)
|
1008
|
+
end
|
1009
|
+
|
790
1010
|
# List all WhatsApp Business Accounts linked to your Amazon Web Services
|
791
1011
|
# account.
|
792
1012
|
#
|
@@ -867,6 +1087,121 @@ module Aws::SocialMessaging
|
|
867
1087
|
req.send_request(options)
|
868
1088
|
end
|
869
1089
|
|
1090
|
+
# Lists WhatsApp message templates for a specific WhatsApp Business
|
1091
|
+
# Account.
|
1092
|
+
#
|
1093
|
+
# @option params [required, String] :id
|
1094
|
+
# The ID of the WhatsApp Business Account to list templates for.
|
1095
|
+
#
|
1096
|
+
# @option params [String] :next_token
|
1097
|
+
# The token for the next page of results.
|
1098
|
+
#
|
1099
|
+
# @option params [Integer] :max_results
|
1100
|
+
# The maximum number of results to return per page (1-100).
|
1101
|
+
#
|
1102
|
+
# @return [Types::ListWhatsAppMessageTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1103
|
+
#
|
1104
|
+
# * {Types::ListWhatsAppMessageTemplatesOutput#templates #templates} => Array<Types::TemplateSummary>
|
1105
|
+
# * {Types::ListWhatsAppMessageTemplatesOutput#next_token #next_token} => String
|
1106
|
+
#
|
1107
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1108
|
+
#
|
1109
|
+
# @example Request syntax with placeholder values
|
1110
|
+
#
|
1111
|
+
# resp = client.list_whats_app_message_templates({
|
1112
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
1113
|
+
# next_token: "NextToken",
|
1114
|
+
# max_results: 1,
|
1115
|
+
# })
|
1116
|
+
#
|
1117
|
+
# @example Response structure
|
1118
|
+
#
|
1119
|
+
# resp.templates #=> Array
|
1120
|
+
# resp.templates[0].template_name #=> String
|
1121
|
+
# resp.templates[0].meta_template_id #=> String
|
1122
|
+
# resp.templates[0].template_status #=> String
|
1123
|
+
# resp.templates[0].template_quality_score #=> String
|
1124
|
+
# resp.templates[0].template_language #=> String
|
1125
|
+
# resp.templates[0].template_category #=> String
|
1126
|
+
# resp.next_token #=> String
|
1127
|
+
#
|
1128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppMessageTemplates AWS API Documentation
|
1129
|
+
#
|
1130
|
+
# @overload list_whats_app_message_templates(params = {})
|
1131
|
+
# @param [Hash] params ({})
|
1132
|
+
def list_whats_app_message_templates(params = {}, options = {})
|
1133
|
+
req = build_request(:list_whats_app_message_templates, params)
|
1134
|
+
req.send_request(options)
|
1135
|
+
end
|
1136
|
+
|
1137
|
+
# Lists templates available in Meta's template library for WhatsApp
|
1138
|
+
# messaging.
|
1139
|
+
#
|
1140
|
+
# @option params [String] :next_token
|
1141
|
+
# The token for the next page of results.
|
1142
|
+
#
|
1143
|
+
# @option params [Integer] :max_results
|
1144
|
+
# The maximum number of results to return per page (1-100).
|
1145
|
+
#
|
1146
|
+
# @option params [required, String] :id
|
1147
|
+
# The ID of the WhatsApp Business Account to list library templates for.
|
1148
|
+
#
|
1149
|
+
# @option params [Hash<String,String>] :filters
|
1150
|
+
# Map of filters to apply (searchKey, topic, usecase, industry,
|
1151
|
+
# language).
|
1152
|
+
#
|
1153
|
+
# @return [Types::ListWhatsAppTemplateLibraryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1154
|
+
#
|
1155
|
+
# * {Types::ListWhatsAppTemplateLibraryOutput#meta_library_templates #meta_library_templates} => Array<Types::MetaLibraryTemplateDefinition>
|
1156
|
+
# * {Types::ListWhatsAppTemplateLibraryOutput#next_token #next_token} => String
|
1157
|
+
#
|
1158
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1159
|
+
#
|
1160
|
+
# @example Request syntax with placeholder values
|
1161
|
+
#
|
1162
|
+
# resp = client.list_whats_app_template_library({
|
1163
|
+
# next_token: "NextToken",
|
1164
|
+
# max_results: 1,
|
1165
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
1166
|
+
# filters: {
|
1167
|
+
# "FilterKeyString" => "FilterValueString",
|
1168
|
+
# },
|
1169
|
+
# })
|
1170
|
+
#
|
1171
|
+
# @example Response structure
|
1172
|
+
#
|
1173
|
+
# resp.meta_library_templates #=> Array
|
1174
|
+
# resp.meta_library_templates[0].template_name #=> String
|
1175
|
+
# resp.meta_library_templates[0].template_language #=> String
|
1176
|
+
# resp.meta_library_templates[0].template_category #=> String
|
1177
|
+
# resp.meta_library_templates[0].template_topic #=> String
|
1178
|
+
# resp.meta_library_templates[0].template_use_case #=> String
|
1179
|
+
# resp.meta_library_templates[0].template_industry #=> Array
|
1180
|
+
# resp.meta_library_templates[0].template_industry[0] #=> String
|
1181
|
+
# resp.meta_library_templates[0].template_header #=> String
|
1182
|
+
# resp.meta_library_templates[0].template_body #=> String
|
1183
|
+
# resp.meta_library_templates[0].template_buttons #=> Array
|
1184
|
+
# resp.meta_library_templates[0].template_buttons[0].type #=> String
|
1185
|
+
# resp.meta_library_templates[0].template_buttons[0].text #=> String
|
1186
|
+
# resp.meta_library_templates[0].template_buttons[0].phone_number #=> String
|
1187
|
+
# resp.meta_library_templates[0].template_buttons[0].url #=> String
|
1188
|
+
# resp.meta_library_templates[0].template_buttons[0].otp_type #=> String
|
1189
|
+
# resp.meta_library_templates[0].template_buttons[0].zero_tap_terms_accepted #=> Boolean
|
1190
|
+
# resp.meta_library_templates[0].template_buttons[0].supported_apps #=> Array
|
1191
|
+
# resp.meta_library_templates[0].template_buttons[0].supported_apps[0] #=> Hash
|
1192
|
+
# resp.meta_library_templates[0].template_buttons[0].supported_apps[0]["SupportedAppKeyString"] #=> String
|
1193
|
+
# resp.meta_library_templates[0].template_id #=> String
|
1194
|
+
# resp.next_token #=> String
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppTemplateLibrary AWS API Documentation
|
1197
|
+
#
|
1198
|
+
# @overload list_whats_app_template_library(params = {})
|
1199
|
+
# @param [Hash] params ({})
|
1200
|
+
def list_whats_app_template_library(params = {}, options = {})
|
1201
|
+
req = build_request(:list_whats_app_template_library, params)
|
1202
|
+
req.send_request(options)
|
1203
|
+
end
|
1204
|
+
|
870
1205
|
# Upload a media file to the WhatsApp service. Only the specified
|
871
1206
|
# `originationPhoneNumberId` has the permissions to send the media file
|
872
1207
|
# when using [SendWhatsAppMessage][1]. You must use either
|
@@ -1102,6 +1437,41 @@ module Aws::SocialMessaging
|
|
1102
1437
|
req.send_request(options)
|
1103
1438
|
end
|
1104
1439
|
|
1440
|
+
# Updates an existing WhatsApp message template.
|
1441
|
+
#
|
1442
|
+
# @option params [required, String] :id
|
1443
|
+
# The ID of the WhatsApp Business Account associated with this template.
|
1444
|
+
#
|
1445
|
+
# @option params [required, String] :meta_template_id
|
1446
|
+
# The numeric ID of the template assigned by Meta.
|
1447
|
+
#
|
1448
|
+
# @option params [String] :template_category
|
1449
|
+
# The new category for the template (for example, UTILITY or MARKETING).
|
1450
|
+
#
|
1451
|
+
# @option params [String, StringIO, File] :template_components
|
1452
|
+
# The updated components of the template as a JSON blob (maximum 3000
|
1453
|
+
# characters).
|
1454
|
+
#
|
1455
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1456
|
+
#
|
1457
|
+
# @example Request syntax with placeholder values
|
1458
|
+
#
|
1459
|
+
# resp = client.update_whats_app_message_template({
|
1460
|
+
# id: "LinkedWhatsAppBusinessAccountId", # required
|
1461
|
+
# meta_template_id: "MetaTemplateId", # required
|
1462
|
+
# template_category: "MetaTemplateCategory",
|
1463
|
+
# template_components: "data",
|
1464
|
+
# })
|
1465
|
+
#
|
1466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/UpdateWhatsAppMessageTemplate AWS API Documentation
|
1467
|
+
#
|
1468
|
+
# @overload update_whats_app_message_template(params = {})
|
1469
|
+
# @param [Hash] params ({})
|
1470
|
+
def update_whats_app_message_template(params = {}, options = {})
|
1471
|
+
req = build_request(:update_whats_app_message_template, params)
|
1472
|
+
req.send_request(options)
|
1473
|
+
end
|
1474
|
+
|
1105
1475
|
# @!endgroup
|
1106
1476
|
|
1107
1477
|
# @param params ({})
|
@@ -1120,7 +1490,7 @@ module Aws::SocialMessaging
|
|
1120
1490
|
tracer: tracer
|
1121
1491
|
)
|
1122
1492
|
context[:gem_name] = 'aws-sdk-socialmessaging'
|
1123
|
-
context[:gem_version] = '1.
|
1493
|
+
context[:gem_version] = '1.11.0'
|
1124
1494
|
Seahorse::Client::Request.new(handlers, context)
|
1125
1495
|
end
|
1126
1496
|
|