/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies the content and settings for a message template that can be used in * messages that are sent through the voice channel.

See Also:

AWS * API Reference

*/ class VoiceTemplateRequest { public: AWS_PINPOINT_API VoiceTemplateRequest(); AWS_PINPOINT_API VoiceTemplateRequest(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API VoiceTemplateRequest& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline const Aws::String& GetBody() const{ return m_body; } /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline bool BodyHasBeenSet() const { return m_bodyHasBeenSet; } /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline void SetBody(const Aws::String& value) { m_bodyHasBeenSet = true; m_body = value; } /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline void SetBody(Aws::String&& value) { m_bodyHasBeenSet = true; m_body = std::move(value); } /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline void SetBody(const char* value) { m_bodyHasBeenSet = true; m_body.assign(value); } /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline VoiceTemplateRequest& WithBody(const Aws::String& value) { SetBody(value); return *this;} /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline VoiceTemplateRequest& WithBody(Aws::String&& value) { SetBody(std::move(value)); return *this;} /** *

The text of the script to use in messages that are based on the message * template, in plain text format.

*/ inline VoiceTemplateRequest& WithBody(const char* value) { SetBody(value); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline const Aws::String& GetDefaultSubstitutions() const{ return m_defaultSubstitutions; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline bool DefaultSubstitutionsHasBeenSet() const { return m_defaultSubstitutionsHasBeenSet; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(const Aws::String& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = value; } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(Aws::String&& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = std::move(value); } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline void SetDefaultSubstitutions(const char* value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions.assign(value); } /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline VoiceTemplateRequest& WithDefaultSubstitutions(const Aws::String& value) { SetDefaultSubstitutions(value); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline VoiceTemplateRequest& WithDefaultSubstitutions(Aws::String&& value) { SetDefaultSubstitutions(std::move(value)); return *this;} /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline VoiceTemplateRequest& WithDefaultSubstitutions(const char* value) { SetDefaultSubstitutions(value); return *this;} /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline const Aws::String& GetLanguageCode() const{ return m_languageCode; } /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline void SetLanguageCode(const Aws::String& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline void SetLanguageCode(Aws::String&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline void SetLanguageCode(const char* value) { m_languageCodeHasBeenSet = true; m_languageCode.assign(value); } /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithLanguageCode(const Aws::String& value) { SetLanguageCode(value); return *this;} /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithLanguageCode(Aws::String&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

The code for the language to use when synthesizing the text of the script in * messages that are based on the message template. For a list of supported * languages and the code for each one, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithLanguageCode(const char* value) { SetLanguageCode(value); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.

(Deprecated) A string-to-string map of * key-value pairs that defines the tags to associate with the message template. * Each tag consists of a required tag key and an associated tag value.

*/ inline VoiceTemplateRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

A custom description of the message template.

*/ inline const Aws::String& GetTemplateDescription() const{ return m_templateDescription; } /** *

A custom description of the message template.

*/ inline bool TemplateDescriptionHasBeenSet() const { return m_templateDescriptionHasBeenSet; } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(const Aws::String& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = value; } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(Aws::String&& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = std::move(value); } /** *

A custom description of the message template.

*/ inline void SetTemplateDescription(const char* value) { m_templateDescriptionHasBeenSet = true; m_templateDescription.assign(value); } /** *

A custom description of the message template.

*/ inline VoiceTemplateRequest& WithTemplateDescription(const Aws::String& value) { SetTemplateDescription(value); return *this;} /** *

A custom description of the message template.

*/ inline VoiceTemplateRequest& WithTemplateDescription(Aws::String&& value) { SetTemplateDescription(std::move(value)); return *this;} /** *

A custom description of the message template.

*/ inline VoiceTemplateRequest& WithTemplateDescription(const char* value) { SetTemplateDescription(value); return *this;} /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline const Aws::String& GetVoiceId() const{ return m_voiceId; } /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline bool VoiceIdHasBeenSet() const { return m_voiceIdHasBeenSet; } /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline void SetVoiceId(const Aws::String& value) { m_voiceIdHasBeenSet = true; m_voiceId = value; } /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline void SetVoiceId(Aws::String&& value) { m_voiceIdHasBeenSet = true; m_voiceId = std::move(value); } /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline void SetVoiceId(const char* value) { m_voiceIdHasBeenSet = true; m_voiceId.assign(value); } /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithVoiceId(const Aws::String& value) { SetVoiceId(value); return *this;} /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithVoiceId(Aws::String&& value) { SetVoiceId(std::move(value)); return *this;} /** *

The name of the voice to use when delivering messages that are based on the * message template. For a list of supported voices, see the Amazon Polly * Developer Guide.

*/ inline VoiceTemplateRequest& WithVoiceId(const char* value) { SetVoiceId(value); return *this;} private: Aws::String m_body; bool m_bodyHasBeenSet = false; Aws::String m_defaultSubstitutions; bool m_defaultSubstitutionsHasBeenSet = false; Aws::String m_languageCode; bool m_languageCodeHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; Aws::String m_templateDescription; bool m_templateDescriptionHasBeenSet = false; Aws::String m_voiceId; bool m_voiceIdHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws