voiceml 0.7.1.1

data/lib/voiceml/models/conferences.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # A Twilio-compatible Conference resource.
+  class Conference
+    ATTRIBUTES = %w[
+      sid account_sid friendly_name status region api_version uri
+      date_created date_updated reason_conference_ended
+      call_sid_ending_conference subresource_uris member_count
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Conferences` response.
+  class ConferenceList
+    include Pageable
+
+    attr_reader :conferences
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @conferences = (hash['conferences'] || []).map { |c| Conference.from_hash(c) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # A participant in a live conference.
+  class Participant
+    ATTRIBUTES = %w[
+      call_sid conference_sid account_sid muted hold coaching call_sid_to_coach queue_time
+      start_conference_on_enter end_conference_on_exit status label
+      api_version uri date_created date_updated
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Conferences/{Sid}/Participants` response.
+  class ParticipantList
+    include Pageable
+
+    attr_reader :participants
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @participants = (hash['participants'] || []).map { |p| Participant.from_hash(p) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/diagnostics.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # `GET /Calls/{Sid}/Notifications` — always an empty list (Twilio-compat stub).
+  class NotificationsList
+    attr_reader :notifications, :page, :page_size, :total, :uri
+
+    def initialize(hash = {})
+      @notifications = hash['notifications'] || []
+      @page          = hash['page']     || 0
+      @page_size     = hash['page_size'] || 0
+      @total         = hash['total']    || 0
+      @uri           = hash['uri']
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # `GET /Calls/{Sid}/Events` — always an empty list (Twilio-compat stub).
+  # The canonical event source is the customer's StatusCallback URL.
+  class EventsList
+    attr_reader :events, :page, :page_size, :total, :uri
+
+    def initialize(hash = {})
+      @events    = hash['events']    || []
+      @page      = hash['page']      || 0
+      @page_size = hash['page_size'] || 0
+      @total     = hash['total']     || 0
+      @uri       = hash['uri']
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # `GET /health` response. Hard-check failures flip `ok` to false (server returns 503);
+  # soft-check warnings surface in `warnings` only.
+  class HealthStatus
+    attr_reader :ok, :warnings, :failures
+
+    def initialize(hash = {})
+      @ok        = hash['ok']
+      @warnings  = (hash['warnings'] || []).map { |w| HealthFailure.from_hash(w) }
+      @failures  = (hash['failures'] || []).map { |f| HealthFailure.from_hash(f) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/incoming_phone_numbers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # A Twilio-compatible IncomingPhoneNumber — a DID assigned to the tenant.
+  #
+  # `sid` is the canonical `PN`-prefixed identifier (34 chars); `phone_number` carries the
+  # E.164 form. These are distinct fields — twilio-ruby callers that lookup-by-number then
+  # fetch-by-sid work unchanged.
+  #
+  # Twilio-compat fields VoiceML doesn't track (regulatory, SMS, emergency, trunking) are
+  # surfaced verbatim so strict-binding consumers can read e.g. `.capabilities['voice']`.
+  class IncomingPhoneNumber
+    ATTRIBUTES = %w[
+      sid account_sid phone_number friendly_name api_version uri
+      voice_url voice_method voice_fallback_url voice_fallback_method
+      voice_application_sid voice_caller_id_lookup voice_receive_mode
+      origin beta capabilities type
+      sms_url sms_method sms_fallback_url sms_fallback_method sms_application_sid
+      status_callback status_callback_method
+      trunk_sid address_sid address_requirements identity_sid bundle_sid
+      emergency_status emergency_address_sid emergency_address_status
+      status date_created date_updated
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /IncomingPhoneNumbers` response. Same envelope shape as `CallList`.
+  class IncomingPhoneNumberList
+    include Pageable
+
+    attr_reader :incoming_phone_numbers
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @incoming_phone_numbers =
+        (hash['incoming_phone_numbers'] || []).map { |n| IncomingPhoneNumber.from_hash(n) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/messages.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # A Twilio-compatible Message resource.
+  #
+  # VoiceML's outbound SMS today is fire-and-forget through the SDK 2.2 gateway —
+  # `status` pins to `"sent"` on successful dispatch and `"failed"` otherwise.
+  # There is no in-flight `queued`/`sending`/`delivered` lifecycle.
+  #
+  # Two wire shapes deserve a note:
+  #
+  # - `num_segments` and `num_media` are **strings** on the wire (Twilio-compatible),
+  #   not integers. `num_media` is always `"0"` because the gateway has no MMS today.
+  # - `error_code` is a nullable integer; `error_message`, `price`, `price_unit`,
+  #   `date_sent`, and `messaging_service_sid` are nullable strings.
+  class Message
+    ATTRIBUTES = %w[
+      sid account_sid api_version to from body status num_segments num_media
+      direction price price_unit error_code error_message messaging_service_sid
+      date_created date_updated date_sent uri subresource_uris
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Messages` response.
+  class MessageList
+    include Pageable
+
+    attr_reader :messages
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @messages = (hash['messages'] || []).map { |m| Message.from_hash(m) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/payments.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module VoiceML
+  # A Twilio-compatible CallPayment resource — the REST companion to the
+  # `<Pay>` TwiML verb.
+  #
+  # The response shape mirrors Twilio's deliberately-minimal payload — runtime
+  # configuration (ChargeAmount, PaymentConnector, ValidCardTypes, etc.) is
+  # captured server-side and not echoed back. Tenant-side BYO is binding: the
+  # account must have `pay_enabled = true` AND a `stripe_secret_key` set, or
+  # the call fails 403.
+  class CallPayment
+    ATTRIBUTES = %w[
+      sid account_sid call_sid api_version
+      date_created date_updated uri
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Narrows the `BankAccountType` field on a Pay session.
+  module PaymentBankAccountType
+    CONSUMER_CHECKING   = 'consumer-checking'
+    CONSUMER_SAVINGS    = 'consumer-savings'
+    COMMERCIAL_CHECKING = 'commercial-checking'
+
+    ALL = [CONSUMER_CHECKING, CONSUMER_SAVINGS, COMMERCIAL_CHECKING].freeze
+  end
+
+  # Narrows the `Input` field. DTMF is the only supported value today.
+  module PaymentInput
+    DTMF = 'dtmf'
+
+    ALL = [DTMF].freeze
+  end
+
+  # Narrows the `PaymentMethod` field.
+  module PaymentMethod
+    CREDIT_CARD = 'credit-card'
+    ACH_DEBIT   = 'ach-debit'
+
+    ALL = [CREDIT_CARD, ACH_DEBIT].freeze
+  end
+
+  # Narrows the `TokenType` field.
+  module PaymentTokenType
+    ONE_TIME       = 'one-time'
+    REUSABLE       = 'reusable'
+    PAYMENT_METHOD = 'payment-method'
+
+    ALL = [ONE_TIME, REUSABLE, PAYMENT_METHOD].freeze
+  end
+
+  # Narrows the `Capture` field on Pay-session updates — tells the runtime
+  # which input the user is about to type next.
+  module PaymentCapture
+    PAYMENT_CARD_NUMBER         = 'payment-card-number'
+    EXPIRATION_DATE             = 'expiration-date'
+    SECURITY_CODE               = 'security-code'
+    POSTAL_CODE                 = 'postal-code'
+    BANK_ROUTING_NUMBER         = 'bank-routing-number'
+    BANK_ACCOUNT_NUMBER         = 'bank-account-number'
+    PAYMENT_CARD_NUMBER_MATCHER = 'payment-card-number-matcher'
+    EXPIRATION_DATE_MATCHER     = 'expiration-date-matcher'
+    SECURITY_CODE_MATCHER       = 'security-code-matcher'
+    POSTAL_CODE_MATCHER         = 'postal-code-matcher'
+
+    ALL = [
+      PAYMENT_CARD_NUMBER, EXPIRATION_DATE, SECURITY_CODE, POSTAL_CODE,
+      BANK_ROUTING_NUMBER, BANK_ACCOUNT_NUMBER,
+      PAYMENT_CARD_NUMBER_MATCHER, EXPIRATION_DATE_MATCHER,
+      SECURITY_CODE_MATCHER, POSTAL_CODE_MATCHER
+    ].freeze
+  end
+
+  # Narrows the `Status` field on Pay-session updates.
+  module PaymentSessionStatus
+    COMPLETE = 'complete'
+    CANCEL   = 'cancel'
+
+    ALL = [COMPLETE, CANCEL].freeze
+  end
+end

data/lib/voiceml/models/queues.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # A Twilio-compatible Queue resource.
+  class Queue
+    ATTRIBUTES = %w[
+      sid account_sid friendly_name current_size max_size
+      average_wait_time date_created date_updated uri
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Queues` response.
+  class QueueList
+    include Pageable
+
+    attr_reader :queues
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @queues = (hash['queues'] || []).map { |q| Queue.from_hash(q) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # A member (call) waiting in a queue.
+  class QueueMember
+    ATTRIBUTES = %w[
+      call_sid queue_sid account_sid date_enqueued wait_time position uri
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Queues/{Sid}/Members` response.
+  class QueueMemberList
+    include Pageable
+
+    attr_reader :queue_members
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @queue_members = (hash['queue_members'] || []).map { |m| QueueMember.from_hash(m) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/recordings.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # A Twilio-compatible Recording resource.
+  class Recording
+    ATTRIBUTES = %w[
+      sid account_sid call_sid conference_sid status source channels
+      duration api_version uri date_created date_updated start_time
+      price price_unit encryption_details subresource_uris media_url error_code
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # `GET /Recordings` (account-scoped) and `GET /Calls/{Sid}/Recordings` (per-call) response.
+  # The per-call form populates only `recordings`; pagination fields remain `nil`.
+  class RecordingList
+    include Pageable
+
+    attr_reader :recordings
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @recordings = (hash['recordings'] || []).map { |r| Recording.from_hash(r) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # Result of fetching `GET /Recordings/{Sid}.wav`. Wraps the WAV bytes with the response's
+  # content-type and whether we followed a 302 -> S3 redirect to retrieve them.
+  class RecordingAudio
+    attr_reader :sid, :content, :content_type, :via_redirect
+
+    def initialize(sid:, content:, content_type:, via_redirect:)
+      @sid          = sid
+      @content      = content
+      @content_type = content_type
+      @via_redirect = via_redirect
+    end
+  end
+end

data/lib/voiceml/models/siprec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # SIPREC-session resource (REST equivalent of `<Start><Siprec>`).
+  class SiprecSession
+    ATTRIBUTES = %w[
+      sid account_sid call_sid name connector_name status api_version uri
+      date_created date_updated
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Calls/{Sid}/Siprec` response.
+  class SiprecList
+    include Pageable
+
+    attr_reader :siprec
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @siprec = (hash['siprec'] || []).map { |s| SiprecSession.from_hash(s) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/streams.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # Media-stream session (REST equivalent of `<Connect><Stream>` / `<Start><Stream>`).
+  class Stream
+    ATTRIBUTES = %w[
+      sid account_sid call_sid name status api_version uri
+      date_created date_updated
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Calls/{Sid}/Streams` response.
+  class StreamList
+    include Pageable
+
+    attr_reader :streams
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @streams = (hash['streams'] || []).map { |s| Stream.from_hash(s) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/transcriptions.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # Real-time per-call transcription (REST equivalent of `<Start><Transcription>`).
+  class CallTranscription
+    ATTRIBUTES = %w[
+      sid account_sid call_sid name language_code transcription_engine
+      status api_version uri date_created date_updated
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      ATTRIBUTES.each do |field|
+        value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
+        instance_variable_set("@#{field}", value)
+      end
+    end
+
+    def self.from_hash(hash)
+      return nil if hash.nil?
+
+      new(hash)
+    end
+  end
+
+  # Paginated `GET /Calls/{Sid}/Transcriptions` response.
+  class TranscriptionList
+    include Pageable
+
+    attr_reader :transcriptions
+
+    def initialize(hash = {})
+      assign_page_fields(hash)
+      @transcriptions = (hash['transcriptions'] || []).map { |t| CallTranscription.from_hash(t) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/resources/applications.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative '../models/applications'
+
+module VoiceML
+  # Operations on `/Applications` — persistent TwiML+callback bundles.
+  class ApplicationsResource < BaseResource
+    APPLICATION_FIELDS = {
+      'FriendlyName'           => :friendly_name,
+      'VoiceUrl'               => :voice_url,
+      'VoiceMethod'            => :voice_method,
+      'VoiceFallbackUrl'       => :voice_fallback_url,
+      'VoiceFallbackMethod'    => :voice_fallback_method,
+      'VoiceCallerIdLookup'    => :voice_caller_id_lookup,
+      'StatusCallback'         => :status_callback,
+      'StatusCallbackMethod'   => :status_callback_method,
+      'StatusCallbackEvent'    => :status_callback_event
+    }.freeze
+
+    LIST_FIELDS = {
+      'FriendlyName' => :friendly_name,
+      'Page'         => :page,
+      'PageSize'     => :page_size,
+      'PageToken'    => :page_token
+    }.freeze
+
+    # @return [VoiceML::Application]
+    def create(**kwargs)
+      Application.from_hash(
+        @transport.request(:post, path('Applications'),
+                           form: form_params(APPLICATION_FIELDS, kwargs))
+      )
+    end
+
+    # @return [VoiceML::ApplicationList]
+    def list(**kwargs)
+      ApplicationList.from_hash(
+        @transport.request(:get, path('Applications'), params: form_params(LIST_FIELDS, kwargs))
+      )
+    end
+
+    # @return [VoiceML::Application]
+    def get(application_sid)
+      Application.from_hash(@transport.request(:get, path('Applications', application_sid)))
+    end
+
+    # @return [VoiceML::Application]
+    def update(application_sid, **kwargs)
+      Application.from_hash(
+        @transport.request(:post, path('Applications', application_sid),
+                           form: form_params(APPLICATION_FIELDS, kwargs))
+      )
+    end
+
+    # @return [nil]
+    def delete(application_sid)
+      @transport.request(:delete, path('Applications', application_sid))
+      nil
+    end
+  end
+end