voiceml 0.9.2 → 0.9.3

data/lib/voiceml/models/common.rb

@@ -2,12 +2,12 @@
 
 module VoiceML
   # Twilio-compatible pagination envelope fields. Mix into list-response classes to expose
-  # `page`, `page_size`, `total`, `next_page_uri`, `previous_page_uri`, `first_page_uri`,
-  # `uri`, `num_pages`, `start`, `end`. The list items themselves are declared on each
-  # concrete subclass (`calls`, `conferences`, etc).
+  # `page`, `page_size`, `start`, `end`, `first_page_uri`, `next_page_uri`, `previous_page_uri`,
+  # `uri`. The list items themselves are declared on each concrete subclass (`calls`,
+  # `conferences`, etc).
   module Pageable
     PAGE_FIELDS = %w[
-      page page_size num_pages total start end
+      page page_size start end
       first_page_uri next_page_uri previous_page_uri uri
     ].freeze
 
@@ -22,6 +22,37 @@ module VoiceML
     end
   end
 
+  # Shared `meta` envelope for `/v1/*` list responses.
+  module V1Pageable
+    META_FIELDS = %w[first_page_url next_page_url previous_page_url url page page_size key].freeze
+
+    META_FIELDS.each { |f| attr_reader f.to_sym }
+
+    def assign_meta_fields(hash)
+      meta = hash['meta'] || {}
+      META_FIELDS.each { |f| instance_variable_set("@#{f}", meta[f]) }
+    end
+  end
+
+  # Mixed into every response model: keeps the raw wire hash readable via
+  # `#to_h` / `#[]` so fields the SDK does not model yet (or newly added
+  # server-side) stay accessible without an SDK release. Unknown fields are
+  # ignored by the typed readers.
+  module RawAttributes
+    # The raw response hash this model was decoded from.
+    def to_h
+      @raw_attributes ||= {}
+    end
+
+    # Read one field from the raw response hash, by either its wire (string)
+    # or symbol name. Returns `nil` for absent fields; `false` round-trips.
+    def [](key)
+      raw = to_h
+      string_key = key.to_s
+      raw.key?(string_key) ? raw[string_key] : raw[key.to_sym]
+    end
+  end
+
   # Twilio-compatible error body. Surface only — the transport raises a VoiceML::ApiError
   # subclass with this payload attached as `error.body`.
   class ErrorBody

data/lib/voiceml/models/conferences.rb

@@ -5,6 +5,7 @@ require_relative 'common'
 module VoiceML
   # A Twilio-compatible Conference resource.
   class Conference
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name status region api_version uri
       date_created date_updated reason_conference_ended
@@ -14,6 +15,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)
@@ -29,11 +31,13 @@ module VoiceML
 
   # Paginated `GET /Conferences` response.
   class ConferenceList
+    include RawAttributes
     include Pageable
 
     attr_reader :conferences
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @conferences = (hash['conferences'] || []).map { |c| Conference.from_hash(c) }
     end
@@ -45,6 +49,7 @@ module VoiceML
 
   # A participant in a live conference.
   class Participant
+    include RawAttributes
     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
@@ -54,6 +59,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)
@@ -69,11 +75,13 @@ module VoiceML
 
   # Paginated `GET /Conferences/{Sid}/Participants` response.
   class ParticipantList
+    include RawAttributes
     include Pageable
 
     attr_reader :participants
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @participants = (hash['participants'] || []).map { |p| Participant.from_hash(p) }
     end