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

Provides information about the status and settings of the SMS channel for an * application.

See Also:

AWS * API Reference

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

The unique identifier for the application that the SMS channel applies * to.

*/ inline const Aws::String& GetApplicationId() const{ return m_applicationId; } /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; } /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; } /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); } /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); } /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline SMSChannelResponse& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;} /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline SMSChannelResponse& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;} /** *

The unique identifier for the application that the SMS channel applies * to.

*/ inline SMSChannelResponse& WithApplicationId(const char* value) { SetApplicationId(value); return *this;} /** *

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

The date and time, in ISO 8601 format, when the SMS channel was enabled.

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

Specifies whether the SMS channel is enabled for the application.

*/ inline bool GetEnabled() const{ return m_enabled; } /** *

Specifies whether the SMS channel is enabled for the application.

*/ inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; } /** *

Specifies whether the SMS channel is enabled for the application.

*/ inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; } /** *

Specifies whether the SMS channel is enabled for the application.

*/ inline SMSChannelResponse& WithEnabled(bool value) { SetEnabled(value); return *this;} /** *

(Not used) This property is retained only for backward compatibility.

*/ inline bool GetHasCredential() const{ return m_hasCredential; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline bool HasCredentialHasBeenSet() const { return m_hasCredentialHasBeenSet; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline void SetHasCredential(bool value) { m_hasCredentialHasBeenSet = true; m_hasCredential = value; } /** *

(Not used) This property is retained only for backward compatibility.

*/ inline SMSChannelResponse& WithHasCredential(bool value) { SetHasCredential(value); return *this;} /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline SMSChannelResponse& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline SMSChannelResponse& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

(Deprecated) An identifier for the SMS channel. This property is retained * only for backward compatibility.

*/ inline SMSChannelResponse& WithId(const char* value) { SetId(value); return *this;} /** *

Specifies whether the SMS channel is archived.

*/ inline bool GetIsArchived() const{ return m_isArchived; } /** *

Specifies whether the SMS channel is archived.

*/ inline bool IsArchivedHasBeenSet() const { return m_isArchivedHasBeenSet; } /** *

Specifies whether the SMS channel is archived.

*/ inline void SetIsArchived(bool value) { m_isArchivedHasBeenSet = true; m_isArchived = value; } /** *

Specifies whether the SMS channel is archived.

*/ inline SMSChannelResponse& WithIsArchived(bool value) { SetIsArchived(value); return *this;} /** *

The user who last modified the SMS channel.

*/ inline const Aws::String& GetLastModifiedBy() const{ return m_lastModifiedBy; } /** *

The user who last modified the SMS channel.

*/ inline bool LastModifiedByHasBeenSet() const { return m_lastModifiedByHasBeenSet; } /** *

The user who last modified the SMS channel.

*/ inline void SetLastModifiedBy(const Aws::String& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = value; } /** *

The user who last modified the SMS channel.

*/ inline void SetLastModifiedBy(Aws::String&& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = std::move(value); } /** *

The user who last modified the SMS channel.

*/ inline void SetLastModifiedBy(const char* value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy.assign(value); } /** *

The user who last modified the SMS channel.

*/ inline SMSChannelResponse& WithLastModifiedBy(const Aws::String& value) { SetLastModifiedBy(value); return *this;} /** *

The user who last modified the SMS channel.

*/ inline SMSChannelResponse& WithLastModifiedBy(Aws::String&& value) { SetLastModifiedBy(std::move(value)); return *this;} /** *

The user who last modified the SMS channel.

*/ inline SMSChannelResponse& WithLastModifiedBy(const char* value) { SetLastModifiedBy(value); return *this;} /** *

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The date and time, in ISO 8601 format, when the SMS channel was last * modified.

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

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline const Aws::String& GetPlatform() const{ return m_platform; } /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline bool PlatformHasBeenSet() const { return m_platformHasBeenSet; } /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline void SetPlatform(const Aws::String& value) { m_platformHasBeenSet = true; m_platform = value; } /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline void SetPlatform(Aws::String&& value) { m_platformHasBeenSet = true; m_platform = std::move(value); } /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline void SetPlatform(const char* value) { m_platformHasBeenSet = true; m_platform.assign(value); } /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline SMSChannelResponse& WithPlatform(const Aws::String& value) { SetPlatform(value); return *this;} /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline SMSChannelResponse& WithPlatform(Aws::String&& value) { SetPlatform(std::move(value)); return *this;} /** *

The type of messaging or notification platform for the channel. For the SMS * channel, this value is SMS.

*/ inline SMSChannelResponse& WithPlatform(const char* value) { SetPlatform(value); return *this;} /** *

The maximum number of promotional messages that you can send through the SMS * channel each second.

*/ inline int GetPromotionalMessagesPerSecond() const{ return m_promotionalMessagesPerSecond; } /** *

The maximum number of promotional messages that you can send through the SMS * channel each second.

*/ inline bool PromotionalMessagesPerSecondHasBeenSet() const { return m_promotionalMessagesPerSecondHasBeenSet; } /** *

The maximum number of promotional messages that you can send through the SMS * channel each second.

*/ inline void SetPromotionalMessagesPerSecond(int value) { m_promotionalMessagesPerSecondHasBeenSet = true; m_promotionalMessagesPerSecond = value; } /** *

The maximum number of promotional messages that you can send through the SMS * channel each second.

*/ inline SMSChannelResponse& WithPromotionalMessagesPerSecond(int value) { SetPromotionalMessagesPerSecond(value); return *this;} /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline const Aws::String& GetSenderId() const{ return m_senderId; } /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline bool SenderIdHasBeenSet() const { return m_senderIdHasBeenSet; } /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline void SetSenderId(const Aws::String& value) { m_senderIdHasBeenSet = true; m_senderId = value; } /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline void SetSenderId(Aws::String&& value) { m_senderIdHasBeenSet = true; m_senderId = std::move(value); } /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline void SetSenderId(const char* value) { m_senderIdHasBeenSet = true; m_senderId.assign(value); } /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline SMSChannelResponse& WithSenderId(const Aws::String& value) { SetSenderId(value); return *this;} /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline SMSChannelResponse& WithSenderId(Aws::String&& value) { SetSenderId(std::move(value)); return *this;} /** *

The identity that displays on recipients' devices when they receive messages * from the SMS channel.

*/ inline SMSChannelResponse& WithSenderId(const char* value) { SetSenderId(value); return *this;} /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline const Aws::String& GetShortCode() const{ return m_shortCode; } /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline bool ShortCodeHasBeenSet() const { return m_shortCodeHasBeenSet; } /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline void SetShortCode(const Aws::String& value) { m_shortCodeHasBeenSet = true; m_shortCode = value; } /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline void SetShortCode(Aws::String&& value) { m_shortCodeHasBeenSet = true; m_shortCode = std::move(value); } /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline void SetShortCode(const char* value) { m_shortCodeHasBeenSet = true; m_shortCode.assign(value); } /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline SMSChannelResponse& WithShortCode(const Aws::String& value) { SetShortCode(value); return *this;} /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline SMSChannelResponse& WithShortCode(Aws::String&& value) { SetShortCode(std::move(value)); return *this;} /** *

The registered short code to use when you send messages through the SMS * channel.

*/ inline SMSChannelResponse& WithShortCode(const char* value) { SetShortCode(value); return *this;} /** *

The maximum number of transactional messages that you can send through the * SMS channel each second.

*/ inline int GetTransactionalMessagesPerSecond() const{ return m_transactionalMessagesPerSecond; } /** *

The maximum number of transactional messages that you can send through the * SMS channel each second.

*/ inline bool TransactionalMessagesPerSecondHasBeenSet() const { return m_transactionalMessagesPerSecondHasBeenSet; } /** *

The maximum number of transactional messages that you can send through the * SMS channel each second.

*/ inline void SetTransactionalMessagesPerSecond(int value) { m_transactionalMessagesPerSecondHasBeenSet = true; m_transactionalMessagesPerSecond = value; } /** *

The maximum number of transactional messages that you can send through the * SMS channel each second.

*/ inline SMSChannelResponse& WithTransactionalMessagesPerSecond(int value) { SetTransactionalMessagesPerSecond(value); return *this;} /** *

The current version of the SMS channel.

*/ inline int GetVersion() const{ return m_version; } /** *

The current version of the SMS channel.

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

The current version of the SMS channel.

*/ inline void SetVersion(int value) { m_versionHasBeenSet = true; m_version = value; } /** *

The current version of the SMS channel.

*/ inline SMSChannelResponse& WithVersion(int value) { SetVersion(value); return *this;} private: Aws::String m_applicationId; bool m_applicationIdHasBeenSet = false; Aws::String m_creationDate; bool m_creationDateHasBeenSet = false; bool m_enabled; bool m_enabledHasBeenSet = false; bool m_hasCredential; bool m_hasCredentialHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; bool m_isArchived; bool m_isArchivedHasBeenSet = false; Aws::String m_lastModifiedBy; bool m_lastModifiedByHasBeenSet = false; Aws::String m_lastModifiedDate; bool m_lastModifiedDateHasBeenSet = false; Aws::String m_platform; bool m_platformHasBeenSet = false; int m_promotionalMessagesPerSecond; bool m_promotionalMessagesPerSecondHasBeenSet = false; Aws::String m_senderId; bool m_senderIdHasBeenSet = false; Aws::String m_shortCode; bool m_shortCodeHasBeenSet = false; int m_transactionalMessagesPerSecond; bool m_transactionalMessagesPerSecondHasBeenSet = false; int m_version; bool m_versionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws