voiceml 0.9.2 → 0.9.3

data/lib/voiceml/models/queues.rb

@@ -5,6 +5,7 @@ require_relative 'common'
 module VoiceML
   # A Twilio-compatible Queue resource.
   class Queue
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name current_size max_size
       average_wait_time date_created date_updated uri
@@ -13,6 +14,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)
@@ -28,11 +30,13 @@ module VoiceML
 
   # Paginated `GET /Queues` response.
   class QueueList
+    include RawAttributes
     include Pageable
 
     attr_reader :queues
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @queues = (hash['queues'] || []).map { |q| Queue.from_hash(q) }
     end
@@ -44,6 +48,7 @@ module VoiceML
 
   # A member (call) waiting in a queue.
   class QueueMember
+    include RawAttributes
     ATTRIBUTES = %w[
       call_sid queue_sid account_sid date_enqueued wait_time position uri
     ].freeze
@@ -51,6 +56,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)
@@ -66,11 +72,13 @@ module VoiceML
 
   # Paginated `GET /Queues/{Sid}/Members` response.
   class QueueMemberList
+    include RawAttributes
     include Pageable
 
     attr_reader :queue_members
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @queue_members = (hash['queue_members'] || []).map { |m| QueueMember.from_hash(m) }
     end

data/lib/voiceml/models/recordings.rb

@@ -5,15 +5,17 @@ require_relative 'common'
 module VoiceML
   # A Twilio-compatible Recording resource.
   class Recording
+    include RawAttributes
     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
+      price price_unit encryption_details subresource_uris media_url error_code track
     ].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)
@@ -30,11 +32,13 @@ module VoiceML
   # `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 RawAttributes
     include Pageable
 
     attr_reader :recordings
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @recordings = (hash['recordings'] || []).map { |r| Recording.from_hash(r) }
     end

data/lib/voiceml/models/routes_v2.rb

@@ -4,13 +4,15 @@ module VoiceML
   # Twilio routes/v2 Inbound Processing Region binding. SID is `QQ...`.
   # Keyed by SIP domain name (not the SipDomain SID).
   class RoutesV2SipDomain
+    include RawAttributes
     ATTRIBUTES = %w[
       sid sip_domain account_sid friendly_name voice_region url
       date_created date_updated
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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
@@ -18,13 +20,15 @@ module VoiceML
   # Twilio routes/v2 Inbound Processing Region binding for a claimed phone number.
   # Keyed by E.164 phone number or its PN sid; account resolved from HTTP Basic auth.
   class RoutesV2PhoneNumber
+    include RawAttributes
     ATTRIBUTES = %w[
       sid phone_number account_sid friendly_name voice_region url
       date_created date_updated
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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

data/lib/voiceml/models/sip.rb

@@ -15,6 +15,7 @@ module VoiceML
 
   # SipDomain — `SD...` resource.
   class SipDomain
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid domain_name api_version friendly_name auth_type
       voice_url voice_method voice_fallback_url voice_fallback_method
@@ -25,15 +26,18 @@ module VoiceML
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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 SipDomainList
+    include RawAttributes
     include Pageable
     attr_reader :domains
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @domains = (hash['domains'] || []).map { |h| SipDomain.from_hash(h) }
     end
@@ -42,20 +46,24 @@ module VoiceML
 
   # SipCredentialList — `CL...`.
   class SipCredentialList
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name date_created date_updated uri subresource_uris
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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 SipCredentialListList
+    include RawAttributes
     include Pageable
     attr_reader :credential_lists
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @credential_lists = (hash['credential_lists'] || []).map { |h| SipCredentialList.from_hash(h) }
     end
@@ -64,13 +72,15 @@ module VoiceML
 
   # SipCredential — `CR...`. Password is write-only (never returned).
   class SipCredential
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid credential_list_sid username
       date_created date_updated uri
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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
@@ -78,9 +88,11 @@ module VoiceML
   # SipCredentialListPage — spec name is `SipCredentialListPage` but it's a page of
   # CREDENTIALS (not credential-lists), mirroring Twilio.
   class SipCredentialListPage
+    include RawAttributes
     include Pageable
     attr_reader :credentials
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @credentials = (hash['credentials'] || []).map { |h| SipCredential.from_hash(h) }
     end
@@ -89,20 +101,24 @@ module VoiceML
 
   # SipIpAccessControlList — `AL...`.
   class SipIpAccessControlList
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name date_created date_updated uri subresource_uris
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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 SipIpAccessControlListList
+    include RawAttributes
     include Pageable
     attr_reader :ip_access_control_lists
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @ip_access_control_lists = (hash['ip_access_control_lists'] || []).map { |h| SipIpAccessControlList.from_hash(h) }
     end
@@ -111,6 +127,7 @@ module VoiceML
 
   # SipIpAddress — `IP...`.
   class SipIpAddress
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid ip_access_control_list_sid
       friendly_name ip_address cidr_prefix_length
@@ -118,15 +135,18 @@ module VoiceML
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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 SipIpAddressList
+    include RawAttributes
     include Pageable
     attr_reader :ip_addresses
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @ip_addresses = (hash['ip_addresses'] || []).map { |h| SipIpAddress.from_hash(h) }
     end
@@ -137,20 +157,24 @@ module VoiceML
   # `sid` echoes the bound resource (CL... for credential mappings, AL... for IP-ACL);
   # `domain_sid` records which domain the binding is attached to.
   class SipDomainMapping
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid friendly_name domain_sid date_created date_updated uri
     ].freeze
     attr_reader(*ATTRIBUTES.map(&:to_sym))
     def initialize(attrs = {})
-      ATTRIBUTES.each { |f| instance_variable_set("@#{f}", attrs[f] || attrs[f.to_sym]) }
+      @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 SipCredentialListMappingList
+    include RawAttributes
     include Pageable
     attr_reader :credential_list_mappings
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @credential_list_mappings = (hash['credential_list_mappings'] || []).map { |h| SipDomainMapping.from_hash(h) }
     end
@@ -158,9 +182,11 @@ module VoiceML
   end
 
   class SipIpAccessControlListMappingList
+    include RawAttributes
     include Pageable
     attr_reader :ip_access_control_list_mappings
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @ip_access_control_list_mappings = (hash['ip_access_control_list_mappings'] || []).map { |h| SipDomainMapping.from_hash(h) }
     end
@@ -173,9 +199,11 @@ module VoiceML
   # the same list shape is reused across CredentialList and IpAccessControlList
   # auth mappings; the inner items decode as SipDomainMapping either way.
   class SipAuthMappingList
+    include RawAttributes
     include Pageable
     attr_reader :contents
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
       @contents = (hash['contents'] || []).map { |h| SipDomainMapping.from_hash(h) }
     end

data/lib/voiceml/models/sip_registrations.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # One live SIP registration on a `SIP/Domains` ingress —
+  # `GET /SIP/Registrations`.
+  class SipRegistration
+    include RawAttributes
+    ATTRIBUTES = %w[
+      aor username domain domain_sid status caller_id user_agent
+      last_registered contacts active_call
+    ].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 /SIP/Registrations` response.
+  class SipRegistrationList
+    include Pageable
+    include RawAttributes
+
+    attr_reader :registrations
+
+    def initialize(hash = {})
+      @raw_attributes = hash
+      assign_page_fields(hash)
+      @registrations = (hash['registrations'] || []).map { |r| SipRegistration.from_hash(r) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/siprec.rb

@@ -4,15 +4,19 @@ require_relative 'common'
 
 module VoiceML
   # SIPREC-session resource (REST equivalent of `<Start><Siprec>`).
+  # Start (`POST /Calls/{Sid}/Siprec`) and stop (`POST /Calls/{Sid}/Siprec/{Sid}`)
+  # are the live operations; the list/fetch GETs were removed from the API.
   class SiprecSession
+    include RawAttributes
     ATTRIBUTES = %w[
-      sid account_sid call_sid name connector_name status api_version uri
+      sid account_sid call_sid name status api_version uri
       date_created date_updated
     ].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)
@@ -25,20 +29,4 @@ module VoiceML
       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

@@ -4,7 +4,10 @@ require_relative 'common'
 
 module VoiceML
   # Media-stream session (REST equivalent of `<Connect><Stream>` / `<Start><Stream>`).
+  # Start (`POST /Calls/{Sid}/Streams`) and stop (`POST /Calls/{Sid}/Streams/{Sid}`)
+  # are the live operations; the list/fetch GETs were removed from the API.
   class Stream
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid call_sid name status api_version uri
       date_created date_updated
@@ -13,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)
@@ -25,20 +29,4 @@ module VoiceML
       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

@@ -5,14 +5,16 @@ require_relative 'common'
 module VoiceML
   # Real-time per-call transcription (REST equivalent of `<Start><Transcription>`).
   class CallTranscription
+    include RawAttributes
     ATTRIBUTES = %w[
-      sid account_sid call_sid name language_code transcription_engine
-      status api_version uri date_created date_updated
+      sid account_sid call_sid name status api_version uri
+      date_created date_updated
     ].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)
@@ -26,15 +28,44 @@ module VoiceML
     end
   end
 
-  # Paginated `GET /Calls/{Sid}/Transcriptions` response.
+  # Stored transcription of a Recording — `GET /Recordings/{Sid}/Transcriptions`
+  # and the account-wide `GET /Transcriptions`.
+  class Transcription
+    include RawAttributes
+    ATTRIBUTES = %w[
+      sid account_sid status recording_sid duration transcription_text type
+      price price_unit api_version uri date_created date_updated
+    ].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 Transcription response (`GET /Transcriptions`,
+  # `GET /Recordings/{RecordingSid}/Transcriptions`).
   class TranscriptionList
     include Pageable
+    include RawAttributes
 
     attr_reader :transcriptions
 
     def initialize(hash = {})
+      @raw_attributes = hash
       assign_page_fields(hash)
-      @transcriptions = (hash['transcriptions'] || []).map { |t| CallTranscription.from_hash(t) }
+      @transcriptions = (hash['transcriptions'] || []).map { |t| Transcription.from_hash(t) }
     end
 
     def self.from_hash(hash)

data/lib/voiceml/models/usage_records.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # One usage bucket from `GET /Usage/Records[/{Window}]`.
+  class UsageRecord
+    include RawAttributes
+    ATTRIBUTES = %w[
+      account_sid api_version as_of category count count_unit description
+      end_date price price_unit start_date subresource_uris uri usage usage_unit
+    ].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 /Usage/Records...` response.
+  class UsageRecordList
+    include Pageable
+    include RawAttributes
+
+    attr_reader :usage_records
+
+    def initialize(hash = {})
+      @raw_attributes = hash
+      assign_page_fields(hash)
+      @usage_records = (hash['usage_records'] || []).map { |r| UsageRecord.from_hash(r) }
+    end
+
+    def self.from_hash(hash)
+      new(hash || {})
+    end
+  end
+end

data/lib/voiceml/models/user_defined_messages.rb

@@ -9,6 +9,7 @@ module VoiceML
   # the model exists to decode the response shape (KX-prefixed sid +
   # account/call sids) for conformance and round-trip tooling.
   class UserDefinedMessage
+    include RawAttributes
     ATTRIBUTES = %w[
       sid account_sid call_sid date_created
     ].freeze
@@ -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)