voiceml 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15e4cbe52a1e5c8c9373bc3b9f636c5637915cf7827abd08c87512998f7fafe4
-  data.tar.gz: bc844da7b2b3289c072d7f5b3ef130a90eace33a0fa7f1794235e3bb096b986c
+  metadata.gz: f65ec54117bee65194bbf24028d00c20d820cee04cc9200472a42b329cd942f8
+  data.tar.gz: 3e2104d7267e31948f3160b37e527cec42acf4a68cb366b4963435f71e55f8ca
 SHA512:
-  metadata.gz: fa0180df722300f7dc736fb67eccd89fd2369c8528d43569eb06e369321d75989a4daee80612c8899354e163ee99fbeda8092bef2e6d561670a94b872fa0b8dc
-  data.tar.gz: a1ca825eac62aa31cb2367340e666a521251055500d0736975ff4a6f5061d9e4e6254d5c4b0e7d643f523cbd03029dc5b4e9840bfd22b7cf07c42775d23ae8fb
+  metadata.gz: dbbe6c38b68861d43ed68d7d3ffa335fb9caf7582fa47b091ca37e29ed3fda725f3b492aab06501c7a61d686c2db1e123fa0fd75e5440ed407a4304646feb19a
+  data.tar.gz: '09ced634a9e275031687a7d3647795a4c7a287928a8da4ffe5f61babd10c86eee840890e5233552e64ddf4aa68a50319ef42cd2a37afe68975d87cddb16dbe69'

data/README.md

@@ -1,8 +1,8 @@
 # 📞 VoiceML Ruby SDK
 
-The official Ruby client for the [VoiceML REST API](https://voicetel.com/docs/api/v0.7/voiceml/) — Twilio-compatible outbound voice and answering-machine-detection from VoiceTel, with idiomatic snake_case kwargs, structured errors, and a Twilio-compatible wire format.
+The official Ruby client for the [VoiceML REST API](https://voicetel.com/docs/api/v0.8/voiceml/) — Twilio-compatible outbound voice and answering-machine-detection from VoiceTel, with idiomatic snake_case kwargs, structured errors, and a Twilio-compatible wire format.
 
-![Version](https://img.shields.io/badge/version-0.8.1-blue)
+![Version](https://img.shields.io/badge/version-0.9.1-blue)
 ![Ruby](https://img.shields.io/badge/ruby-3.0%2B-red)
 ![License](https://img.shields.io/badge/license-MIT-green)
 ![Tests](https://img.shields.io/badge/tests-65%20specs-brightgreen)
@@ -110,7 +110,7 @@ client = VoiceML::Client.new(account_sid: 'AC...', api_key: '...')
 client.diagnostics.health  # uses your AccountSid + key on every call
 ```
 
-> Don't have credentials yet? See **[voicetel.com/docs/api/v0.7/voiceml/](https://voicetel.com/docs/api/v0.7/voiceml/)** for issuance and rotation.
+> Don't have credentials yet? See **[voicetel.com/docs/api/v0.8/voiceml/](https://voicetel.com/docs/api/v0.8/voiceml/)** for issuance and rotation.
 
 ## 🗺️ Resource Reference
 
@@ -245,7 +245,7 @@ gem build voiceml.gemspec
 
 ## 📖 API Documentation
 
-- **Reference docs:** [voicetel.com/docs/api/v0.7/voiceml/](https://voicetel.com/docs/api/v0.7/voiceml/)
+- **Reference docs:** [voicetel.com/docs/api/v0.8/voiceml/](https://voicetel.com/docs/api/v0.8/voiceml/)
 - **Validator:** [voicetel.com/voiceml/validator/](https://voicetel.com/voiceml/validator/)
 - **SDK catalogue:** [voicetel.com/docs/voiceml-sdks/](https://voicetel.com/docs/voiceml-sdks/)
 - **YARD comments:** every resource method carries `@param` / `@return` docs — `yard doc lib` builds them locally.

data/lib/voiceml/client.rb

@@ -12,6 +12,9 @@ require_relative 'resources/diagnostics'
 require_relative 'resources/messages'
 require_relative 'resources/sip'
 require_relative 'resources/routes_v2'
+require_relative 'resources/voice_v1'
+require_relative 'resources/conversations_v1'
+require_relative 'resources/assistants_v1'
 
 module VoiceML
   # Synchronous client for the VoiceML REST API.
@@ -31,7 +34,7 @@ module VoiceML
   class Client
     attr_reader :calls, :conferences, :queues, :applications, :recordings,
                 :incoming_phone_numbers, :notifications, :diagnostics, :messages,
-                :sip, :routes_v2
+                :sip, :routes_v2, :voice_v1, :conversations_v1, :assistants_v1
 
     # @param account_sid [String] Twilio-format AccountSid (`AC` + 32 hex).
     # @param api_key     [String, nil] per-tenant API key. Pass either `api_key:` or the
@@ -75,6 +78,9 @@ module VoiceML
       @messages               = MessagesResource.new(@transport)
       @sip                    = SipResource.new(@transport)
       @routes_v2              = RoutesV2Resource.new(@transport)
+      @voice_v1               = VoiceV1Resource.new(@transport)
+      @conversations_v1       = ConversationsV1Resource.new(@transport)
+      @assistants_v1          = AssistantsV1Resource.new(@transport)
     end
 
     def account_sid

data/lib/voiceml/models/accounts.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module VoiceML
+  # Twilio-compatible Account resource. The voiceml SDK is single-account
+  # (the credential's account is implicit on every call), so this model
+  # exists primarily to decode `GET/POST /Accounts/{Sid}.json` responses
+  # round-trip with the Twilio shape — useful for migration tooling that
+  # echoes the account record back to the caller.
+  class Account
+    ATTRIBUTES = %w[
+      sid friendly_name status type auth_token owner_account_sid
+      date_created date_updated subresource_uris 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
+
+  # `GET /Accounts/{Sid}/Balance.json` — running balance for the account in
+  # the account's settlement currency. No `sid` field on the wire (the
+  # balance is account-scoped, not its own resource).
+  class Balance
+    ATTRIBUTES = %w[account_sid balance currency].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
+end

data/lib/voiceml/models/assistants_v1.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative 'voice_v1' # V1Pageable lives here; Assistants v1 reuses the same `meta` envelope
+
+module VoiceML
+  # Assistants v1 (`/v1/Assistants`, `/v1/Tools`, `/v1/Knowledge`, `/v1/Sessions`,
+  # `/v1/Policies`) — Twilio AI-Assistants surface. Same /v1 conventions as Voice v1
+  # and Conversations v1: Basic-auth account resolution, ISO-8601 dates, `meta`
+  # list envelope (V1Pageable). 7 families for v0.9.1:
+  #   - Assistant (aia_asst_...)
+  #   - Tool (aia_tool_...) + ToolWithPolicies fetch shape
+  #   - Knowledge (aia_know_...) + KnowledgeStatus + KnowledgeChunk
+  #   - Session
+  #   - Message (aia_msg_...) + SendMessageResponse
+  #   - Feedback (aia_fdbk_...)
+  #   - Policy (aia_plcy_...)
+
+  # AssistantsV1Assistant — `aia_asst_...`. Used by list/create/update/delete responses.
+  class AssistantsV1Assistant
+    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 = {})
+      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 V1Pageable
+    attr_reader :assistants
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @assistants = (hash['assistants'] || []).map { |h| AssistantsV1Assistant.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1AssistantWithToolsAndKnowledge — fetch-one shape that includes the
+  # attached tools and knowledge arrays inline.
+  class AssistantsV1AssistantWithToolsAndKnowledge
+    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 = {})
+      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
+
+  # AssistantsV1Tool — `aia_tool_...`.
+  class AssistantsV1Tool
+    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 = {})
+      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 V1Pageable
+    attr_reader :tools
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @tools = (hash['tools'] || []).map { |h| AssistantsV1Tool.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1ToolWithPolicies — fetch-one shape that includes the policies array inline.
+  class AssistantsV1ToolWithPolicies
+    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 = {})
+      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
+
+  # AssistantsV1Knowledge — `aia_know_...`.
+  class AssistantsV1Knowledge
+    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 = {})
+      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 V1Pageable
+    attr_reader :knowledge
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @knowledge = (hash['knowledge'] || []).map { |h| AssistantsV1Knowledge.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1KnowledgeStatus — read-only ingestion status snapshot.
+  class AssistantsV1KnowledgeStatus
+    ATTRIBUTES = %w[account_sid status last_status date_updated].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(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
+
+  # AssistantsV1KnowledgeChunk — single retrieved chunk of indexed Knowledge content.
+  class AssistantsV1KnowledgeChunk
+    ATTRIBUTES = %w[account_sid content metadata date_created date_updated].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(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 V1Pageable
+    attr_reader :chunks
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @chunks = (hash['chunks'] || []).map { |h| AssistantsV1KnowledgeChunk.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1Session — a chat session between an identity and an Assistant.
+  class AssistantsV1Session
+    ATTRIBUTES = %w[
+      id account_sid assistant_id verified identity date_created date_updated
+    ].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(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 V1Pageable
+    attr_reader :sessions
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @sessions = (hash['sessions'] || []).map { |h| AssistantsV1Session.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1Message — `aia_msg_...`. One message in an Assistant session.
+  class AssistantsV1Message
+    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 = {})
+      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 V1Pageable
+    attr_reader :messages
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @messages = (hash['messages'] || []).map { |h| AssistantsV1Message.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1SendMessageResponse — POST /v1/Assistants/{id}/Messages return shape.
+  # Distinct from AssistantsV1Message: carries the model's reply body + flag/abort signals.
+  class AssistantsV1SendMessageResponse
+    ATTRIBUTES = %w[status flagged aborted session_id account_sid body error].freeze
+    attr_reader(*ATTRIBUTES.map(&:to_sym))
+    def initialize(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
+
+  # AssistantsV1Feedback — `aia_fdbk_...`. Numeric score + text feedback on a message.
+  class AssistantsV1Feedback
+    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 = {})
+      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 V1Pageable
+    attr_reader :feedbacks
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @feedbacks = (hash['feedbacks'] || []).map { |h| AssistantsV1Feedback.from_hash(h) }
+    end
+  end
+
+  # AssistantsV1Policy — `aia_plcy_...`. Read-only — listed under /v1/Policies (filterable
+  # by ToolId/KnowledgeId) and embedded inline on Tool fetch responses.
+  class AssistantsV1Policy
+    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 = {})
+      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 V1Pageable
+    attr_reader :policies
+    def initialize(hash = {})
+      assign_meta_fields(hash)
+      @policies = (hash['policies'] || []).map { |h| AssistantsV1Policy.from_hash(h) }
+    end
+  end
+end