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

Provides information about a message template that's associated with your * Amazon Pinpoint account.

See Also:

AWS * API Reference

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

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline TemplateResponse& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline TemplateResponse& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the message template. This value isn't * included in a TemplateResponse object. To retrieve the ARN of a template, use * the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the ARN * for.

*/ inline TemplateResponse& WithArn(const char* value) { SetArn(value); return *this;} /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline const Aws::String& GetCreationDate() const{ return m_creationDate; } /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); } /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline TemplateResponse& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;} /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline TemplateResponse& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;} /** *

The date, in ISO 8601 format, when the message template was created.

*/ inline TemplateResponse& WithCreationDate(const char* value) { SetCreationDate(value); return *this;} /** *

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The JSON object that specifies the default values that are used for message * variables in the message template. This object isn't included in a * TemplateResponse object. To retrieve this object for a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * object for.

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

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline const Aws::String& GetLastModifiedDate() const{ return m_lastModifiedDate; } /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline bool LastModifiedDateHasBeenSet() const { return m_lastModifiedDateHasBeenSet; } /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline void SetLastModifiedDate(const Aws::String& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = value; } /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline void SetLastModifiedDate(Aws::String&& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = std::move(value); } /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline void SetLastModifiedDate(const char* value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate.assign(value); } /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline TemplateResponse& WithLastModifiedDate(const Aws::String& value) { SetLastModifiedDate(value); return *this;} /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline TemplateResponse& WithLastModifiedDate(Aws::String&& value) { SetLastModifiedDate(std::move(value)); return *this;} /** *

The date, in ISO 8601 format, when the message template was last * modified.

*/ inline TemplateResponse& WithLastModifiedDate(const char* value) { SetLastModifiedDate(value); return *this;} /** *

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

A map of key-value pairs that identifies the tags that are associated with * the message template. This object isn't included in a TemplateResponse object. * To retrieve this object for a template, use the GetEmailTemplate, * GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the * type of template that you want to retrieve the object for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The custom description of the message template. This value isn't included in * a TemplateResponse object. To retrieve the description of a template, use the * GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate * operation, depending on the type of template that you want to retrieve the * description for.

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

The name of the message template.

*/ inline const Aws::String& GetTemplateName() const{ return m_templateName; } /** *

The name of the message template.

*/ inline bool TemplateNameHasBeenSet() const { return m_templateNameHasBeenSet; } /** *

The name of the message template.

*/ inline void SetTemplateName(const Aws::String& value) { m_templateNameHasBeenSet = true; m_templateName = value; } /** *

The name of the message template.

*/ inline void SetTemplateName(Aws::String&& value) { m_templateNameHasBeenSet = true; m_templateName = std::move(value); } /** *

The name of the message template.

*/ inline void SetTemplateName(const char* value) { m_templateNameHasBeenSet = true; m_templateName.assign(value); } /** *

The name of the message template.

*/ inline TemplateResponse& WithTemplateName(const Aws::String& value) { SetTemplateName(value); return *this;} /** *

The name of the message template.

*/ inline TemplateResponse& WithTemplateName(Aws::String&& value) { SetTemplateName(std::move(value)); return *this;} /** *

The name of the message template.

*/ inline TemplateResponse& WithTemplateName(const char* value) { SetTemplateName(value); return *this;} /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline const TemplateType& GetTemplateType() const{ return m_templateType; } /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline bool TemplateTypeHasBeenSet() const { return m_templateTypeHasBeenSet; } /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline void SetTemplateType(const TemplateType& value) { m_templateTypeHasBeenSet = true; m_templateType = value; } /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline void SetTemplateType(TemplateType&& value) { m_templateTypeHasBeenSet = true; m_templateType = std::move(value); } /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline TemplateResponse& WithTemplateType(const TemplateType& value) { SetTemplateType(value); return *this;} /** *

The type of channel that the message template is designed for. Possible * values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

*/ inline TemplateResponse& WithTemplateType(TemplateType&& value) { SetTemplateType(std::move(value)); return *this;} /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline const Aws::String& GetVersion() const{ return m_version; } /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; } /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline void SetVersion(const Aws::String& value) { m_versionHasBeenSet = true; m_version = value; } /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline void SetVersion(Aws::String&& value) { m_versionHasBeenSet = true; m_version = std::move(value); } /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline void SetVersion(const char* value) { m_versionHasBeenSet = true; m_version.assign(value); } /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline TemplateResponse& WithVersion(const Aws::String& value) { SetVersion(value); return *this;} /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline TemplateResponse& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;} /** *

The unique identifier, as an integer, for the active version of the message * template.

*/ inline TemplateResponse& WithVersion(const char* value) { SetVersion(value); return *this;} private: Aws::String m_arn; bool m_arnHasBeenSet = false; Aws::String m_creationDate; bool m_creationDateHasBeenSet = false; Aws::String m_defaultSubstitutions; bool m_defaultSubstitutionsHasBeenSet = false; Aws::String m_lastModifiedDate; bool m_lastModifiedDateHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; Aws::String m_templateDescription; bool m_templateDescriptionHasBeenSet = false; Aws::String m_templateName; bool m_templateNameHasBeenSet = false; TemplateType m_templateType; bool m_templateTypeHasBeenSet = false; Aws::String m_version; bool m_versionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws