voiceml 0.9.1 → 0.9.3

data/lib/voiceml/models/diagnostics.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require_relative 'common'
+require_relative 'notifications'
 
 module VoiceML
   # `GET /Calls/{Sid}/Notifications` — always an empty list (Twilio-compat stub).
   class NotificationsList
-    attr_reader :notifications, :page, :page_size, :total, :uri
+    include RawAttributes
+    include Pageable
+    attr_reader :notifications
 
     def initialize(hash = {})
-      @notifications = hash['notifications'] || []
-      @page          = hash['page']     || 0
-      @page_size     = hash['page_size'] || 0
-      @total         = hash['total']    || 0
-      @uri           = hash['uri']
+      @raw_attributes = hash
+      assign_page_fields(hash)
+      @notifications = (hash['notifications'] || []).map { |n| Notification.from_hash(n) }
     end
 
     def self.from_hash(hash)
@@ -23,14 +24,14 @@ module VoiceML
   # `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
+    include RawAttributes
+    include Pageable
+    attr_reader :events
 
     def initialize(hash = {})
-      @events    = hash['events']    || []
-      @page      = hash['page']      || 0
-      @page_size = hash['page_size'] || 0
-      @total     = hash['total']     || 0
-      @uri       = hash['uri']
+      @raw_attributes = hash
+      assign_page_fields(hash)
+      @events = (hash['events'] || []).map { |event| CallEvent.from_hash(event) }
     end
 
     def self.from_hash(hash)
@@ -38,12 +39,32 @@ module VoiceML
     end
   end
 
+  # Request/response pair from a call's event log.
+  class CallEvent
+    include RawAttributes
+    ATTRIBUTES = %w[request response].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      @raw_attributes = attrs
+      ATTRIBUTES.each do |field|
+        instance_variable_set("@#{field}", attrs.key?(field) ? attrs[field] : attrs[field.to_sym])
+      end
+    end
+
+    def self.from_hash(hash)
+      hash.nil? ? nil : 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
+    include RawAttributes
     attr_reader :ok, :warnings, :failures
 
     def initialize(hash = {})
+      @raw_attributes = hash
       @ok        = hash['ok']
       @warnings  = (hash['warnings'] || []).map { |w| HealthFailure.from_hash(w) }
       @failures  = (hash['failures'] || []).map { |f| HealthFailure.from_hash(f) }

data/lib/voiceml/models/exports.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # One day's archive entry from `GET /Exports`.
+  class Export
+    include RawAttributes
+    ATTRIBUTES = %w[date size uri].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      @raw_attributes = 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 /Exports` response — the account's available archives, newest first.
+  class ExportList
+    include RawAttributes
+
+    attr_reader :account_sid, :uri, :exports
+
+    def initialize(hash = {})
+      @raw_attributes = hash
+      @account_sid = hash['account_sid']
+      @uri         = hash['uri']
+      @exports     = (hash['exports'] || []).map { |e| Export.from_hash(e) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+
+  # Result of `GET /Exports/{Date}` — the archive bytes, following the same
+  # 302 -> presigned-object redirect recording audio uses.
+  class ExportDownload
+    attr_reader :date, :content, :content_type, :via_redirect
+
+    def initialize(date:, content:, content_type:, via_redirect:)
+      @date         = date
+      @content      = content
+      @content_type = content_type
+      @via_redirect = via_redirect
+    end
+  end
+end

data/lib/voiceml/models/incoming_phone_numbers.rb

@@ -12,6 +12,7 @@ module VoiceML
   # 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
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid phone_number friendly_name api_version uri
       voice_url voice_method voice_fallback_url voice_fallback_method
@@ -27,6 +28,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)
@@ -42,11 +44,13 @@ module VoiceML
 
   # Paginated `GET /IncomingPhoneNumbers` response. Same envelope shape as `CallList`.
   class IncomingPhoneNumberList
+    include RawAttributes
     include Pageable
 
     attr_reader :incoming_phone_numbers
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @incoming_phone_numbers =
         (hash['incoming_phone_numbers'] || []).map { |n| IncomingPhoneNumber.from_hash(n) }

data/lib/voiceml/models/media.rb

@@ -8,6 +8,7 @@ module VoiceML
   # shape conformance and to round-trip migrated tooling. `parent_sid` ties
   # the media back to its parent Message (SM... sid).
   class Media
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid parent_sid content_type
       date_created date_updated uri
@@ -16,6 +17,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)
@@ -32,11 +34,13 @@ module VoiceML
   # Paginated `GET /Messages/{Sid}/Media` response. Twilio's envelope key is
   # `media_list` (not `media`) — the SDK preserves that on the wire.
   class MediaList
+    include RawAttributes
     include Pageable
 
     attr_reader :media_list
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @media_list = (hash['media_list'] || []).map { |m| Media.from_hash(m) }
     end

data/lib/voiceml/models/messages.rb

@@ -16,6 +16,7 @@ module VoiceML
   # - `error_code` is a nullable integer; `error_message`, `price`, `price_unit`,
   #   `date_sent`, and `messaging_service_sid` are nullable strings.
   class Message
+    include RawAttributes
     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
@@ -25,6 +26,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)
@@ -40,11 +42,13 @@ module VoiceML
 
   # Paginated `GET /Messages` response.
   class MessageList
+    include RawAttributes
     include Pageable
 
     attr_reader :messages
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @messages = (hash['messages'] || []).map { |m| Message.from_hash(m) }
     end
@@ -53,4 +57,29 @@ module VoiceML
       new(hash || {})
     end
   end
+
+  # Delivery-quality feedback echoed back on a Message
+  # (`POST /Messages/{Sid}/Feedback.json`). VoiceML records the outcome on
+  # the response only; there is no separate downstream analytics surface.
+  # Any submitted `Outcome` other than `confirmed` echoes as `unconfirmed`.
+  class MessageFeedback
+    include RawAttributes
+    ATTRIBUTES = %w[account_sid message_sid outcome date_created date_updated uri].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      @raw_attributes = 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
 end

data/lib/voiceml/models/messaging_v1.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative 'voice_v1' # V1Pageable lives here; Messaging v1 reuses the same `meta` envelope
+
+module VoiceML
+  # Twilio Messaging v1 (messaging.twilio.com/v1) resources.
+  #
+  # A Messaging Service (`MG...`) shares the `/v1/Services` path shape with the
+  # Conversations Service (`IS...`); the two are disambiguated on the wire by host
+  # (`messaging.voicetel.com` vs `conversations.voicetel.com`). This SDK routes
+  # `client.messaging_v1.*` at the messaging host automatically — see VoiceML::Hosts.
+
+  # MessagingService — `MG...`. The feature-toggle fields are accept-and-echo on
+  # VoiceML; the service's operative role is gating scheduled sends.
+  class MessagingService
+    include RawAttributes
+    ATTRIBUTES = %w[
+      sid account_sid friendly_name date_created date_updated
+      inbound_request_url inbound_method fallback_url fallback_method status_callback
+      sticky_sender mms_converter smart_encoding scan_message_content
+      fallback_to_long_code area_code_geomatch synchronous_validation validity_period
+      url usecase use_inbound_webhook_on_number advanced_opt_out
+    ].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(attrs = {})
+      @raw_attributes = attrs
+      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs.key?(f) ? attrs[f] : attrs[f.to_sym]) }
+    end
+    def self.from_hash(h); h.nil? ? nil : new(h); end
+  end
+
+  # List envelope for `GET /v1/Services` on the messaging host.
+  class MessagingServiceList
+    include RawAttributes
+    include V1Pageable
+    attr_reader :services
+    def initialize(hash = {})
+      @raw_attributes = hash
+      assign_meta_fields(hash)
+      @services = (hash['services'] || []).map { |h| MessagingService.from_hash(h) }
+    end
+  end
+
+  # MessagingServicePhoneNumber — a sender-pool phone number attached to a
+  # Messaging Service (`/v1/Services/{ChatServiceSid}/PhoneNumbers`). Lives on
+  # the messaging host.
+  class MessagingServicePhoneNumber
+    include RawAttributes
+    ATTRIBUTES = %w[
+      sid account_sid service_sid date_created date_updated
+      phone_number country_code capabilities url
+    ].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(attrs = {})
+      @raw_attributes = attrs
+      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs.key?(f) ? attrs[f] : attrs[f.to_sym]) }
+    end
+    def self.from_hash(h); h.nil? ? nil : new(h); end
+  end
+
+  # List envelope for `GET /v1/Services/{ChatServiceSid}/PhoneNumbers`.
+  class MessagingServicePhoneNumberList
+    include RawAttributes
+    include V1Pageable
+    attr_reader :phone_numbers
+    def initialize(hash = {})
+      @raw_attributes = hash
+      assign_meta_fields(hash)
+      @phone_numbers = (hash['phone_numbers'] || []).map { |h| MessagingServicePhoneNumber.from_hash(h) }
+    end
+  end
+end

data/lib/voiceml/models/monitor_v1.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # Monitor v1 (`/v1/Alerts`) — failure events rendered in the Monitor Alert
+  # shape: call-scoped errors and messaging delivery failures alike.
+  #
+  # List rows omit the request/response detail; `fetch` includes it when the
+  # underlying event stored any (`request_headers`, `request_variables`,
+  # `response_body`, `response_headers`).
+  class MonitorAlert
+    include RawAttributes
+    ATTRIBUTES = %w[
+      sid account_sid alert_text api_version error_code log_level more_info
+      request_method request_url request_headers request_variables
+      response_body response_headers resource_sid service_sid
+      date_created date_generated date_updated url
+    ].freeze
+
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+
+    def initialize(attrs = {})
+      @raw_attributes = 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 /v1/Alerts` response: `alerts` plus the standard `/v1`
+  # `meta` envelope. The server serves a single page
+  # (`meta.next_page_url` is always `null`); `PageSize` does limit this
+  # collection (default 50, capped at 1000).
+  class MonitorAlertList
+    include RawAttributes
+    include V1Pageable
+
+    attr_reader :alerts
+
+    def initialize(hash = {})
+      @raw_attributes = hash
+      assign_meta_fields(hash)
+      @alerts = (hash['alerts'] || []).map { |h| MonitorAlert.from_hash(h) }
+    end
+  end
+end

data/lib/voiceml/models/notifications.rb

@@ -13,6 +13,7 @@ module VoiceML
   #
   # The same resource shape backs both account-scoped and call-scoped fetches.
   class Notification
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid call_sid api_version
       error_code more_info message_date message_text log
@@ -24,6 +25,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)

data/lib/voiceml/models/outgoing_caller_ids.rb

@@ -7,6 +7,7 @@ module VoiceML
   # to mirror Twilio (caller-id resources share the IncomingPhoneNumber SID
   # space upstream); `phone_number` carries the verified E.164 number.
   class OutgoingCallerId
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name phone_number
       date_created date_updated uri
@@ -15,6 +16,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)
@@ -30,11 +32,13 @@ module VoiceML
 
   # Paginated `GET /OutgoingCallerIds` response.
   class OutgoingCallerIdList
+    include RawAttributes
     include Pageable
 
     attr_reader :outgoing_caller_ids
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @outgoing_caller_ids =
         (hash['outgoing_caller_ids'] || []).map { |o| OutgoingCallerId.from_hash(o) }
@@ -50,11 +54,13 @@ module VoiceML
   # doesn't exist until the validation_code is dialled back); the
   # `validation_code` is what the user is prompted to enter on the live call.
   class ValidationRequest
+    include RawAttributes
     ATTRIBUTES = %w[account_sid call_sid friendly_name phone_number validation_code].freeze
 
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)

data/lib/voiceml/models/payments.rb

@@ -10,6 +10,7 @@ module VoiceML
   # account must have `pay_enabled = true` AND a `stripe_secret_key` set, or
   # the call fails 403.
   class CallPayment
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid call_sid api_version
       date_created date_updated uri
@@ -18,6 +19,7 @@ module VoiceML
     attr_reader(*ATTRIBUTES.map(&:to_sym))
 
     def initialize(attrs = {})
+      @raw_attributes = attrs
       ATTRIBUTES.each do |field|
         value = attrs.key?(field) ? attrs[field] : attrs[field.to_sym]
         instance_variable_set("@#{field}", value)