399 lines
18 KiB
C++
399 lines
18 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/pinpoint/Pinpoint_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace Pinpoint
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Specifies the content and settings for a message template that can be used in
|
|
* text messages that are sent through the SMS channel.</p><p><h3>See Also:</h3>
|
|
* <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SMSTemplateRequest">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_PINPOINT_API SMSTemplateRequest
|
|
{
|
|
public:
|
|
SMSTemplateRequest();
|
|
SMSTemplateRequest(Aws::Utils::Json::JsonView jsonValue);
|
|
SMSTemplateRequest& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline const Aws::String& GetBody() const{ return m_body; }
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline bool BodyHasBeenSet() const { return m_bodyHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline void SetBody(const Aws::String& value) { m_bodyHasBeenSet = true; m_body = value; }
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline void SetBody(Aws::String&& value) { m_bodyHasBeenSet = true; m_body = std::move(value); }
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline void SetBody(const char* value) { m_bodyHasBeenSet = true; m_body.assign(value); }
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithBody(const Aws::String& value) { SetBody(value); return *this;}
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithBody(Aws::String&& value) { SetBody(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The message body to use in text messages that are based on the message
|
|
* template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithBody(const char* value) { SetBody(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline const Aws::String& GetDefaultSubstitutions() const{ return m_defaultSubstitutions; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline bool DefaultSubstitutionsHasBeenSet() const { return m_defaultSubstitutionsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetDefaultSubstitutions(const Aws::String& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = value; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetDefaultSubstitutions(Aws::String&& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = std::move(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetDefaultSubstitutions(const char* value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions.assign(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithDefaultSubstitutions(const Aws::String& value) { SetDefaultSubstitutions(value); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithDefaultSubstitutions(Aws::String&& value) { SetDefaultSubstitutions(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithDefaultSubstitutions(const char* value) { SetDefaultSubstitutions(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline const Aws::String& GetRecommenderId() const{ return m_recommenderId; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline bool RecommenderIdHasBeenSet() const { return m_recommenderIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline void SetRecommenderId(const Aws::String& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = value; }
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline void SetRecommenderId(Aws::String&& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline void SetRecommenderId(const char* value) { m_recommenderIdHasBeenSet = true; m_recommenderId.assign(value); }
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithRecommenderId(const Aws::String& value) { SetRecommenderId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithRecommenderId(Aws::String&& value) { SetRecommenderId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The unique identifier for the recommender model to use for the message
|
|
* template. Amazon Pinpoint uses this value to determine how to retrieve and
|
|
* process data from a recommender model when it sends messages that use the
|
|
* template, if the template contains message variables for recommendation
|
|
* data.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithRecommenderId(const char* value) { SetRecommenderId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline SMSTemplateRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline const Aws::String& GetTemplateDescription() const{ return m_templateDescription; }
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline bool TemplateDescriptionHasBeenSet() const { return m_templateDescriptionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline void SetTemplateDescription(const Aws::String& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = value; }
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline void SetTemplateDescription(Aws::String&& value) { m_templateDescriptionHasBeenSet = true; m_templateDescription = std::move(value); }
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline void SetTemplateDescription(const char* value) { m_templateDescriptionHasBeenSet = true; m_templateDescription.assign(value); }
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithTemplateDescription(const Aws::String& value) { SetTemplateDescription(value); return *this;}
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithTemplateDescription(Aws::String&& value) { SetTemplateDescription(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A custom description of the message template.</p>
|
|
*/
|
|
inline SMSTemplateRequest& WithTemplateDescription(const char* value) { SetTemplateDescription(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_body;
|
|
bool m_bodyHasBeenSet;
|
|
|
|
Aws::String m_defaultSubstitutions;
|
|
bool m_defaultSubstitutionsHasBeenSet;
|
|
|
|
Aws::String m_recommenderId;
|
|
bool m_recommenderIdHasBeenSet;
|
|
|
|
Aws::Map<Aws::String, Aws::String> m_tags;
|
|
bool m_tagsHasBeenSet;
|
|
|
|
Aws::String m_templateDescription;
|
|
bool m_templateDescriptionHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace Pinpoint
|
|
} // namespace Aws
|