module TMS #:nodoc:
  # A VoiceMessage is used to create and send a voice message to a collection of Recipient
  # objects.  The recipients are called and the provided +play_url+ is
  # played to them.  Accepted sound formats include +wav+, +mp3+, and +aiff+.
  #
  #
  # @attr play_url [String] The url to the sound file to be played back to the call recipients
  # @attr say_text [String] A string to be read (and repeated on request) to the call recipients.
  #
  # @example
  #    voice_message = client.voice_messages.build(:play_url => "http://example.com/emergency_weather.mp3")
  #    voice_message.recipients.build(:phone => "+18001002000")
  #    voice_message.post
  #    voice_message.get
  class VoiceMessage
    include InstanceResource

    # @!parse attr_accessor :play_url, :play_url
    writeable_attributes :play_url, :say_text

    # @!parse attr_reader :created_at, :completed_at, :status
    readonly_attributes :created_at, :completed_at, :status

    ##
    # A CollectionResource of Recipient objects
    collection_attributes :recipients

    ##
    # A CollectionResource of Recipients that sent successfully
    collection_attribute :sent, 'Recipients'

    ##
    # A CollectionResource of Recipients that failed
    collection_attribute :failed, 'Recipients'

    def self.to_s
      "VoiceMessage"
    end
  end
end