aws-sdk-socialmessaging 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440cbbaa5336a431ee168bbadbd821c9585583150006a7cd9b9693e64f7530f2
-  data.tar.gz: 56180e572034d19bd3e90b0a47a10c3611a7f0d4495d19c4965c3e84fdb2d304
+  metadata.gz: d88618b3d1e8a2164f518ba94e0184977cc670049b668d48e5d7036085d4c444
+  data.tar.gz: 5e724940b75805925809bcbf409ea4391d5325e393f4348d0d21d8b79440bd60
 SHA512:
-  metadata.gz: 465dfaa77240e3121cbe614326eeadd96e9d088e31c8eed734ba00f8d632052583286b155a4bb16a258ed5b4328f01f01ccf2bf29d299287db0faad32c097e1b
-  data.tar.gz: 69eb475dfb06538724d05cf42db2d664a5c1cb7c9345a636add414d2e3e340e56ab85b7216add02b7d09f7ebc8e1c98b8137573af47f1d6f6e1aee50362b6fa1
+  metadata.gz: a94f956ff6cdd8f3d5111fc48c4e23cbe2647e78ca497deaa35d966701003cf5b2cf34c56f9961c5a25b879d556d3d5e9c458e2e084abefe459d4ce06ac6b093
+  data.tar.gz: 1a4239ee09bf796903e33ba36923e560d67145905277cfe3a85d918816bad8bc582921a68defbc5e972a12ca5fddf1f3872ab4db2c65a1680aaef442b6b6f1bd

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.11.0 (2025-07-25)
+------------------
+
+* 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
+
 1.10.0 (2025-07-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

data/lib/aws-sdk-socialmessaging/client.rb

@@ -500,6 +500,7 @@ module Aws::SocialMessaging
     #   resp = client.associate_whats_app_business_account({
     #     signup_callback: {
     #       access_token: "WhatsAppSignupCallbackAccessTokenString", # required
+    #       callback_url: "WhatsAppSignupCallbackCallbackUrlString",
     #     },
     #     setup_finalization: {
     #       associate_in_progress_token: "AssociateInProgressToken", # required
@@ -549,6 +550,7 @@ module Aws::SocialMessaging
     #   resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number_name #=> String
     #   resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number #=> String
     #   resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].quality_rating #=> String
+    #   resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].data_localization_region #=> String
     #   resp.signup_callback_result.linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].waba_id #=> String
     #   resp.status_code #=> Integer
     #
@@ -561,6 +563,146 @@ module Aws::SocialMessaging
       req.send_request(options)
     end
 
+    # Creates a new WhatsApp message template from a custom definition.
+    #
+    # @option params [required, String, StringIO, File] :template_definition
+    #   The complete template definition as a JSON blob.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account to associate with this
+    #   template.
+    #
+    # @return [Types::CreateWhatsAppMessageTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWhatsAppMessageTemplateOutput#meta_template_id #meta_template_id} => String
+    #   * {Types::CreateWhatsAppMessageTemplateOutput#template_status #template_status} => String
+    #   * {Types::CreateWhatsAppMessageTemplateOutput#category #category} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_whats_app_message_template({
+    #     template_definition: "data", # required
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.meta_template_id #=> String
+    #   resp.template_status #=> String
+    #   resp.category #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplate AWS API Documentation
+    #
+    # @overload create_whats_app_message_template(params = {})
+    # @param [Hash] params ({})
+    def create_whats_app_message_template(params = {}, options = {})
+      req = build_request(:create_whats_app_message_template, params)
+      req.send_request(options)
+    end
+
+    # Creates a new WhatsApp message template using a template from Meta's
+    # template library.
+    #
+    # @option params [required, Types::MetaLibraryTemplate] :meta_library_template
+    #   The template configuration from Meta's library, including
+    #   customizations for buttons and body text.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account to associate with this
+    #   template.
+    #
+    # @return [Types::CreateWhatsAppMessageTemplateFromLibraryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#meta_template_id #meta_template_id} => String
+    #   * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#template_status #template_status} => String
+    #   * {Types::CreateWhatsAppMessageTemplateFromLibraryOutput#category #category} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_whats_app_message_template_from_library({
+    #     meta_library_template: { # required
+    #       template_name: "MetaTemplateName", # required
+    #       library_template_name: "MetaTemplateName", # required
+    #       template_category: "MetaTemplateCategory", # required
+    #       template_language: "MetaTemplateLanguage", # required
+    #       library_template_button_inputs: [
+    #         {
+    #           type: "ButtonType",
+    #           phone_number: "PhoneNumber",
+    #           url: {
+    #             "MetaUrlWithSuffixExampleKeyString" => "MetaUrlWithSuffixExampleValueString",
+    #           },
+    #           otp_type: "OtpType",
+    #           zero_tap_terms_accepted: false,
+    #           supported_apps: [
+    #             {
+    #               "SupportedAppKeyString" => "SupportedAppValueString",
+    #             },
+    #           ],
+    #         },
+    #       ],
+    #       library_template_body_inputs: {
+    #         add_contact_number: false,
+    #         add_learn_more_link: false,
+    #         add_security_recommendation: false,
+    #         add_track_package_link: false,
+    #         code_expiration_minutes: 1,
+    #       },
+    #     },
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.meta_template_id #=> String
+    #   resp.template_status #=> String
+    #   resp.category #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplateFromLibrary AWS API Documentation
+    #
+    # @overload create_whats_app_message_template_from_library(params = {})
+    # @param [Hash] params ({})
+    def create_whats_app_message_template_from_library(params = {}, options = {})
+      req = build_request(:create_whats_app_message_template_from_library, params)
+      req.send_request(options)
+    end
+
+    # Uploads media for use in a WhatsApp message template.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account associated with this media
+    #   upload.
+    #
+    # @option params [Types::S3File] :source_s3_file
+    #   Contains information for the S3 bucket that contains media files.
+    #
+    # @return [Types::CreateWhatsAppMessageTemplateMediaOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWhatsAppMessageTemplateMediaOutput#meta_header_handle #meta_header_handle} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_whats_app_message_template_media({
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #     source_s3_file: {
+    #       bucket_name: "S3FileBucketNameString", # required
+    #       key: "S3FileKeyString", # required
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.meta_header_handle #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/CreateWhatsAppMessageTemplateMedia AWS API Documentation
+    #
+    # @overload create_whats_app_message_template_media(params = {})
+    # @param [Hash] params ({})
+    def create_whats_app_message_template_media(params = {}, options = {})
+      req = build_request(:create_whats_app_message_template_media, params)
+      req.send_request(options)
+    end
+
     # Delete a media object from the WhatsApp service. If the object is
     # still in an Amazon S3 bucket you should delete it from there too.
     #
@@ -606,6 +748,40 @@ module Aws::SocialMessaging
       req.send_request(options)
     end
 
+    # Deletes a WhatsApp message template.
+    #
+    # @option params [String] :meta_template_id
+    #   The numeric ID of the template assigned by Meta.
+    #
+    # @option params [Boolean] :delete_all_languages
+    #   If true, deletes all language versions of the template.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account associated with this template.
+    #
+    # @option params [required, String] :template_name
+    #   The name of the template to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_whats_app_message_template({
+    #     meta_template_id: "MetaTemplateId",
+    #     delete_all_languages: false,
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #     template_name: "MetaTemplateName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/DeleteWhatsAppMessageTemplate AWS API Documentation
+    #
+    # @overload delete_whats_app_message_template(params = {})
+    # @param [Hash] params ({})
+    def delete_whats_app_message_template(params = {}, options = {})
+      req = build_request(:delete_whats_app_message_template, params)
+      req.send_request(options)
+    end
+
     # Disassociate a WhatsApp Business Account (WABA) from your Amazon Web
     # Services account.
     #
@@ -678,6 +854,7 @@ module Aws::SocialMessaging
     #   resp.account.phone_numbers[0].display_phone_number_name #=> String
     #   resp.account.phone_numbers[0].display_phone_number #=> String
     #   resp.account.phone_numbers[0].quality_rating #=> String
+    #   resp.account.phone_numbers[0].data_localization_region #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccount AWS API Documentation
     #
@@ -721,6 +898,7 @@ module Aws::SocialMessaging
     #   resp.phone_number.display_phone_number_name #=> String
     #   resp.phone_number.display_phone_number #=> String
     #   resp.phone_number.quality_rating #=> String
+    #   resp.phone_number.data_localization_region #=> String
     #   resp.linked_whats_app_business_account_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetLinkedWhatsAppBusinessAccountPhoneNumber AWS API Documentation
@@ -797,6 +975,38 @@ module Aws::SocialMessaging
       req.send_request(options)
     end
 
+    # Retrieves a specific WhatsApp message template.
+    #
+    # @option params [required, String] :meta_template_id
+    #   The numeric ID of the template assigned by Meta.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account associated with this template.
+    #
+    # @return [Types::GetWhatsAppMessageTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetWhatsAppMessageTemplateOutput#template #template} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_whats_app_message_template({
+    #     meta_template_id: "MetaTemplateId", # required
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.template #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/GetWhatsAppMessageTemplate AWS API Documentation
+    #
+    # @overload get_whats_app_message_template(params = {})
+    # @param [Hash] params ({})
+    def get_whats_app_message_template(params = {}, options = {})
+      req = build_request(:get_whats_app_message_template, params)
+      req.send_request(options)
+    end
+
     # List all WhatsApp Business Accounts linked to your Amazon Web Services
     # account.
     #
@@ -877,6 +1087,121 @@ module Aws::SocialMessaging
       req.send_request(options)
     end
 
+    # Lists WhatsApp message templates for a specific WhatsApp Business
+    # Account.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account to list templates for.
+    #
+    # @option params [String] :next_token
+    #   The token for the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page (1-100).
+    #
+    # @return [Types::ListWhatsAppMessageTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWhatsAppMessageTemplatesOutput#templates #templates} => Array<Types::TemplateSummary>
+    #   * {Types::ListWhatsAppMessageTemplatesOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_whats_app_message_templates({
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.templates #=> Array
+    #   resp.templates[0].template_name #=> String
+    #   resp.templates[0].meta_template_id #=> String
+    #   resp.templates[0].template_status #=> String
+    #   resp.templates[0].template_quality_score #=> String
+    #   resp.templates[0].template_language #=> String
+    #   resp.templates[0].template_category #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppMessageTemplates AWS API Documentation
+    #
+    # @overload list_whats_app_message_templates(params = {})
+    # @param [Hash] params ({})
+    def list_whats_app_message_templates(params = {}, options = {})
+      req = build_request(:list_whats_app_message_templates, params)
+      req.send_request(options)
+    end
+
+    # Lists templates available in Meta's template library for WhatsApp
+    # messaging.
+    #
+    # @option params [String] :next_token
+    #   The token for the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page (1-100).
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account to list library templates for.
+    #
+    # @option params [Hash<String,String>] :filters
+    #   Map of filters to apply (searchKey, topic, usecase, industry,
+    #   language).
+    #
+    # @return [Types::ListWhatsAppTemplateLibraryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWhatsAppTemplateLibraryOutput#meta_library_templates #meta_library_templates} => Array&lt;Types::MetaLibraryTemplateDefinition&gt;
+    #   * {Types::ListWhatsAppTemplateLibraryOutput#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_whats_app_template_library({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #     filters: {
+    #       "FilterKeyString" => "FilterValueString",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.meta_library_templates #=> Array
+    #   resp.meta_library_templates[0].template_name #=> String
+    #   resp.meta_library_templates[0].template_language #=> String
+    #   resp.meta_library_templates[0].template_category #=> String
+    #   resp.meta_library_templates[0].template_topic #=> String
+    #   resp.meta_library_templates[0].template_use_case #=> String
+    #   resp.meta_library_templates[0].template_industry #=> Array
+    #   resp.meta_library_templates[0].template_industry[0] #=> String
+    #   resp.meta_library_templates[0].template_header #=> String
+    #   resp.meta_library_templates[0].template_body #=> String
+    #   resp.meta_library_templates[0].template_buttons #=> Array
+    #   resp.meta_library_templates[0].template_buttons[0].type #=> String
+    #   resp.meta_library_templates[0].template_buttons[0].text #=> String
+    #   resp.meta_library_templates[0].template_buttons[0].phone_number #=> String
+    #   resp.meta_library_templates[0].template_buttons[0].url #=> String
+    #   resp.meta_library_templates[0].template_buttons[0].otp_type #=> String
+    #   resp.meta_library_templates[0].template_buttons[0].zero_tap_terms_accepted #=> Boolean
+    #   resp.meta_library_templates[0].template_buttons[0].supported_apps #=> Array
+    #   resp.meta_library_templates[0].template_buttons[0].supported_apps[0] #=> Hash
+    #   resp.meta_library_templates[0].template_buttons[0].supported_apps[0]["SupportedAppKeyString"] #=> String
+    #   resp.meta_library_templates[0].template_id #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/ListWhatsAppTemplateLibrary AWS API Documentation
+    #
+    # @overload list_whats_app_template_library(params = {})
+    # @param [Hash] params ({})
+    def list_whats_app_template_library(params = {}, options = {})
+      req = build_request(:list_whats_app_template_library, params)
+      req.send_request(options)
+    end
+
     # Upload a media file to the WhatsApp service. Only the specified
     # `originationPhoneNumberId` has the permissions to send the media file
     # when using [SendWhatsAppMessage][1]. You must use either
@@ -1112,6 +1437,41 @@ module Aws::SocialMessaging
       req.send_request(options)
     end
 
+    # Updates an existing WhatsApp message template.
+    #
+    # @option params [required, String] :id
+    #   The ID of the WhatsApp Business Account associated with this template.
+    #
+    # @option params [required, String] :meta_template_id
+    #   The numeric ID of the template assigned by Meta.
+    #
+    # @option params [String] :template_category
+    #   The new category for the template (for example, UTILITY or MARKETING).
+    #
+    # @option params [String, StringIO, File] :template_components
+    #   The updated components of the template as a JSON blob (maximum 3000
+    #   characters).
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_whats_app_message_template({
+    #     id: "LinkedWhatsAppBusinessAccountId", # required
+    #     meta_template_id: "MetaTemplateId", # required
+    #     template_category: "MetaTemplateCategory",
+    #     template_components: "data",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/socialmessaging-2024-01-01/UpdateWhatsAppMessageTemplate AWS API Documentation
+    #
+    # @overload update_whats_app_message_template(params = {})
+    # @param [Hash] params ({})
+    def update_whats_app_message_template(params = {}, options = {})
+      req = build_request(:update_whats_app_message_template, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -1130,7 +1490,7 @@ module Aws::SocialMessaging
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-socialmessaging'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.11.0'
       Seahorse::Client::Request.new(handlers, context)
     end