voiceml 0.9.1 → 0.9.3

data/lib/voiceml/models/assistants_v1.rb

@@ -18,21 +18,25 @@ module VoiceML
 
   # AssistantsV1Assistant — `aia_asst_...`. Used by list/create/update/delete responses.
   class AssistantsV1Assistant
+    include RawAttributes
     ATTRIBUTES = %w[
       account_sid customer_ai id model name owner url personality_prompt
       date_created date_updated
     ].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
 
   class AssistantsV1AssistantList
+    include RawAttributes
     include V1Pageable
     attr_reader :assistants
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @assistants = (hash['assistants'] || []).map { |h| AssistantsV1Assistant.from_hash(h) }
     end
@@ -41,12 +45,14 @@ module VoiceML
   # AssistantsV1AssistantWithToolsAndKnowledge — fetch-one shape that includes the
   # attached tools and knowledge arrays inline.
   class AssistantsV1AssistantWithToolsAndKnowledge
+    include RawAttributes
     ATTRIBUTES = %w[
       account_sid customer_ai id model name owner url personality_prompt
       date_created date_updated tools knowledge
     ].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
@@ -54,21 +60,25 @@ module VoiceML
 
   # AssistantsV1Tool — `aia_tool_...`.
   class AssistantsV1Tool
+    include RawAttributes
     ATTRIBUTES = %w[
       account_sid description enabled id meta name requires_auth type url
       date_created date_updated
     ].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
 
   class AssistantsV1ToolList
+    include RawAttributes
     include V1Pageable
     attr_reader :tools
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @tools = (hash['tools'] || []).map { |h| AssistantsV1Tool.from_hash(h) }
     end
@@ -76,12 +86,14 @@ module VoiceML
 
   # AssistantsV1ToolWithPolicies — fetch-one shape that includes the policies array inline.
   class AssistantsV1ToolWithPolicies
+    include RawAttributes
     ATTRIBUTES = %w[
       account_sid description enabled id meta name requires_auth type url
       date_created date_updated policies
     ].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
@@ -89,21 +101,25 @@ module VoiceML
 
   # AssistantsV1Knowledge — `aia_know_...`.
   class AssistantsV1Knowledge
+    include RawAttributes
     ATTRIBUTES = %w[
       account_sid description id knowledge_source_details name status type url
       embedding_model date_created date_updated
     ].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
 
   class AssistantsV1KnowledgeList
+    include RawAttributes
     include V1Pageable
     attr_reader :knowledge
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @knowledge = (hash['knowledge'] || []).map { |h| AssistantsV1Knowledge.from_hash(h) }
     end
@@ -111,9 +127,11 @@ module VoiceML
 
   # AssistantsV1KnowledgeStatus — read-only ingestion status snapshot.
   class AssistantsV1KnowledgeStatus
+    include RawAttributes
     ATTRIBUTES = %w[account_sid status last_status date_updated].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
@@ -121,18 +139,22 @@ module VoiceML
 
   # AssistantsV1KnowledgeChunk — single retrieved chunk of indexed Knowledge content.
   class AssistantsV1KnowledgeChunk
+    include RawAttributes
     ATTRIBUTES = %w[account_sid content metadata date_created date_updated].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
 
   class AssistantsV1KnowledgeChunkList
+    include RawAttributes
     include V1Pageable
     attr_reader :chunks
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @chunks = (hash['chunks'] || []).map { |h| AssistantsV1KnowledgeChunk.from_hash(h) }
     end
@@ -140,20 +162,24 @@ module VoiceML
 
   # AssistantsV1Session — a chat session between an identity and an Assistant.
   class AssistantsV1Session
+    include RawAttributes
     ATTRIBUTES = %w[
       id account_sid assistant_id verified identity date_created date_updated
     ].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
 
   class AssistantsV1SessionList
+    include RawAttributes
     include V1Pageable
     attr_reader :sessions
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @sessions = (hash['sessions'] || []).map { |h| AssistantsV1Session.from_hash(h) }
     end
@@ -161,21 +187,25 @@ module VoiceML
 
   # AssistantsV1Message — `aia_msg_...`. One message in an Assistant session.
   class AssistantsV1Message
+    include RawAttributes
     ATTRIBUTES = %w[
       id account_sid assistant_id session_id identity role content meta
       date_created date_updated
     ].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
 
   class AssistantsV1MessageList
+    include RawAttributes
     include V1Pageable
     attr_reader :messages
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @messages = (hash['messages'] || []).map { |h| AssistantsV1Message.from_hash(h) }
     end
@@ -184,9 +214,11 @@ module VoiceML
   # AssistantsV1SendMessageResponse — POST /v1/Assistants/{id}/Messages return shape.
   # Distinct from AssistantsV1Message: carries the model's reply body + flag/abort signals.
   class AssistantsV1SendMessageResponse
+    include RawAttributes
     ATTRIBUTES = %w[status flagged aborted session_id account_sid body error].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
@@ -194,21 +226,25 @@ module VoiceML
 
   # AssistantsV1Feedback — `aia_fdbk_...`. Numeric score + text feedback on a message.
   class AssistantsV1Feedback
+    include RawAttributes
     ATTRIBUTES = %w[
       assistant_id id account_sid user_sid message_id score session_id text
       date_created date_updated
     ].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
 
   class AssistantsV1FeedbackList
+    include RawAttributes
     include V1Pageable
     attr_reader :feedbacks
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @feedbacks = (hash['feedbacks'] || []).map { |h| AssistantsV1Feedback.from_hash(h) }
     end
@@ -217,21 +253,25 @@ module VoiceML
   # AssistantsV1Policy — `aia_plcy_...`. Read-only — listed under /v1/Policies (filterable
   # by ToolId/KnowledgeId) and embedded inline on Tool fetch responses.
   class AssistantsV1Policy
+    include RawAttributes
     ATTRIBUTES = %w[
       id name description account_sid user_sid type policy_details
       date_created date_updated
     ].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
 
   class AssistantsV1PolicyList
+    include RawAttributes
     include V1Pageable
     attr_reader :policies
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_meta_fields(hash)
       @policies = (hash['policies'] || []).map { |h| AssistantsV1Policy.from_hash(h) }
     end

data/lib/voiceml/models/calls.rb

@@ -6,6 +6,7 @@ module VoiceML
   # A Twilio-compatible Call resource. Returned by `client.calls.create`, `client.calls.get`,
   # `client.calls.update`, and listed in `CallList#calls`.
   class Call
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid api_version to to_formatted from from_formatted
       parent_call_sid caller_name forwarded_from status direction
@@ -17,6 +18,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 /Calls` response.
   class CallList
+    include RawAttributes
     include Pageable
 
     attr_reader :calls
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @calls = (hash['calls'] || []).map { |c| Call.from_hash(c) }
     end

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