revox 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1f941b71b36c901ec274276697c8dcf693173bd4d145274f796e21051e72d7
-  data.tar.gz: ff2b649eca49ad723ef282ad3e66341d6215593e56d519425b3fc95f9bc85aaa
+  metadata.gz: 665d2197b2774b34796d5e9acd358118f3148e7711386209395d3cbf7bc6b36c
+  data.tar.gz: 9053cc3a625b2164be340a4cf0b305ea4fa3cfc701ff7234780f2d4bbd58b2e0
 SHA512:
-  metadata.gz: b986e4cc31e63b39c847069c46e13621161950be1f1c797ae17c90faf925059fdd2ccea38f659373bc2286555b770875a116b0e73ed6e2d1df5af0f759895965
-  data.tar.gz: ee8f4d005dfd233c530a1463b1e5c7be1bda0e9c33622b620528b4b761171aaa8ec8c1217baae329a96a410cebfd75be88e53c4c52f0786444837f19ca742aeb
+  metadata.gz: f89828b3e79ed23b2dca0a18a53f73a23212202dba7c96e5c30e0b171a62badc763aa6a293798c3405c0c39aec25133bd1d5cd8a802c8c8e613554ecd3b412b5
+  data.tar.gz: 572fed5f3e6e978f6839c0671a02972d60d151ce9c84731b4398ffb08334240c060eb6014e9e882e789e6e65ed61a75bed763e85b8c91df56657b2546223ab09

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.1.0 (2026-03-11)
+
+Full Changelog: [v0.0.2...v0.1.0](https://github.com/revoxai/revox-ruby/compare/v0.0.2...v0.1.0)
+
+### Features
+
+* **api:** api update ([26b8dce](https://github.com/revoxai/revox-ruby/commit/26b8dce142fe60e4bb1973fa05070ac3448dbfa1))
+* **api:** api update ([d14fa2f](https://github.com/revoxai/revox-ruby/commit/d14fa2f89269badb9d46dd3afa4a820bcbead622))
+* **api:** manual updates ([dc9e13f](https://github.com/revoxai/revox-ruby/commit/dc9e13fb6e419133fe735d48d88e7e8474e24e2c))
+
+
+### Bug Fixes
+
+* properly mock time in ruby ci tests ([ad9d571](https://github.com/revoxai/revox-ruby/commit/ad9d57106369993a3f96437ce0c49620c5ebe9e9))
+
+
+### Chores
+
+* **ci:** add build step ([77847b4](https://github.com/revoxai/revox-ruby/commit/77847b4b7ee8f85a064caf68a1921cc5a5b073fa))
+* **ci:** skip uploading artifacts on stainless-internal branches ([388307a](https://github.com/revoxai/revox-ruby/commit/388307a619f30dc9896e7bdfbd5dedb2c52cdf2c))
+* configure new SDK language ([9f54c02](https://github.com/revoxai/revox-ruby/commit/9f54c0276bd7412aed447e23d2ccf8e58e3d5774))
+* **internal:** codegen related update ([cfeb246](https://github.com/revoxai/revox-ruby/commit/cfeb24661d45158cdd9d84d3963d659634c085fd))
+* **internal:** codegen related update ([2eb1fe1](https://github.com/revoxai/revox-ruby/commit/2eb1fe1363a17c960e90a734be8dd6ff772634f1))
+* update SDK settings ([c60774d](https://github.com/revoxai/revox-ruby/commit/c60774d4c01b5590b11eb9f59d07c8621ac2d17c))
+
 ## 0.0.2 (2026-02-20)
 
 Full Changelog: [v0.0.1...v0.0.2](https://github.com/revoxai/revox-ruby/compare/v0.0.1...v0.0.2)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "revox", "~> 0.0.2"
+gem "revox", "~> 0.1.0"
 ```
 
 <!-- x-release-please-end -->
@@ -30,9 +30,13 @@ revox = Revox::Client.new(
   api_key: ENV["REVOX_API_KEY"] # This is the default and can be omitted
 )
 
-assistant = revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME")
+campaign = revox.campaigns.create(
+  assistant_id: "REPLACE_ME",
+  contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  name: "REPLACE_ME"
+)
 
-puts(assistant.assistant)
+puts(campaign.campaign)
 ```
 
 ### Handling errors
@@ -41,7 +45,11 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  assistant = revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME")
+  campaign = revox.campaigns.create(
+    assistant_id: "REPLACE_ME",
+    contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+    name: "REPLACE_ME"
+  )
 rescue Revox::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -84,7 +92,12 @@ revox = Revox::Client.new(
 )
 
 # Or, configure per-request:
-revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME", request_options: {max_retries: 5})
+revox.campaigns.create(
+  assistant_id: "REPLACE_ME",
+  contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  name: "REPLACE_ME",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -98,7 +111,12 @@ revox = Revox::Client.new(
 )
 
 # Or, configure per-request:
-revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME", request_options: {timeout: 5})
+revox.campaigns.create(
+  assistant_id: "REPLACE_ME",
+  contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  name: "REPLACE_ME",
+  request_options: {timeout: 5}
+)
 ```
 
 On timeout, `Revox::Errors::APITimeoutError` is raised.
@@ -128,10 +146,11 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-assistant =
-  revox.assistants.create(
+campaign =
+  revox.campaigns.create(
+    assistant_id: "REPLACE_ME",
+    contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
     name: "REPLACE_ME",
-    prompt: "REPLACE_ME",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -139,7 +158,7 @@ assistant =
     }
   )
 
-puts(assistant[:my_undocumented_property])
+puts(campaign[:my_undocumented_property])
 ```
 
 #### Undocumented request params
@@ -177,18 +196,40 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME")
+revox.campaigns.create(
+  assistant_id: "REPLACE_ME",
+  contacts: [
+    Revox::CampaignCreateParams::Contact.new(
+      prompt_variables: {foo: "string"},
+      to_phone_number: "to_phone_number"
+    )
+  ],
+  name: "REPLACE_ME"
+)
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-revox.assistants.create(name: "REPLACE_ME", prompt: "REPLACE_ME")
+revox.campaigns.create(
+  assistant_id: "REPLACE_ME",
+  contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  name: "REPLACE_ME"
+)
 
 # You can also splat a full Params class:
-params = Revox::AssistantCreateParams.new(name: "REPLACE_ME", prompt: "REPLACE_ME")
-revox.assistants.create(**params)
+params = Revox::CampaignCreateParams.new(
+  assistant_id: "REPLACE_ME",
+  contacts: [
+    Revox::CampaignCreateParams::Contact.new(
+      prompt_variables: {foo: "string"},
+      to_phone_number: "to_phone_number"
+    )
+  ],
+  name: "REPLACE_ME"
+)
+revox.campaigns.create(**params)
 ```
 
 ### Enums
@@ -196,25 +237,25 @@ revox.assistants.create(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :generated
-puts(Revox::AssistantCreateParams::FirstSentenceMode::GENERATED)
+# :IVR
+puts(Revox::CampaignGetRowsParams::Result::IVR)
 
-# Revealed type: `T.all(Revox::AssistantCreateParams::FirstSentenceMode, Symbol)`
-T.reveal_type(Revox::AssistantCreateParams::FirstSentenceMode::GENERATED)
+# Revealed type: `T.all(Revox::CampaignGetRowsParams::Result, Symbol)`
+T.reveal_type(Revox::CampaignGetRowsParams::Result::IVR)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-revox.assistants.create(
-  first_sentence_mode: Revox::AssistantCreateParams::FirstSentenceMode::GENERATED,
+revox.campaigns.get_rows(
+  result: Revox::CampaignGetRowsParams::Result::IVR,
   # …
 )
 
 # Literal values are also permissible:
-revox.assistants.create(
-  first_sentence_mode: :generated,
+revox.campaigns.get_rows(
+  result: :IVR,
   # …
 )
 ```

data/lib/revox/client.rb

@@ -18,6 +18,9 @@ module Revox
     # @return [String]
     attr_reader :api_key
 
+    # @return [Revox::Resources::Campaigns]
+    attr_reader :campaigns
+
     # @return [Revox::Resources::Assistants]
     attr_reader :assistants
 
@@ -77,6 +80,7 @@ module Revox
         max_retry_delay: max_retry_delay
       )
 
+      @campaigns = Revox::Resources::Campaigns.new(client: self)
       @assistants = Revox::Resources::Assistants.new(client: self)
       @call = Revox::Resources::Call.new(client: self)
       @voices = Revox::Resources::Voices.new(client: self)

data/lib/revox/internal/type/base_model.rb

@@ -438,9 +438,9 @@ module Revox
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `assistant_create_response` is a `Revox::Models::AssistantCreateResponse`
-        #   assistant_create_response => {
-        #     assistant: assistant
+        #   # `campaign_create_response` is a `Revox::Models::CampaignCreateResponse`
+        #   campaign_create_response => {
+        #     campaign: campaign
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/revox/internal/util.rb

@@ -490,6 +490,37 @@ module Revox
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/revox/models/assistant_create_params.rb

@@ -28,7 +28,7 @@ module Revox
       # @!attribute calendly
       #
       #   @return [Revox::Models::AssistantCreateParams::Calendly, nil]
-      optional :calendly, -> { Revox::AssistantCreateParams::Calendly }, nil?: true
+      optional :calendly, -> { Revox::AssistantCreateParams::Calendly }
 
       # @!attribute call_retry_config
       #   Configuration for call retry behavior including time windows, delays, and max
@@ -135,7 +135,7 @@ module Revox
       #
       #   @param background_sound [Symbol, Revox::Models::AssistantCreateParams::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
       #
-      #   @param calendly [Revox::Models::AssistantCreateParams::Calendly, nil]
+      #   @param calendly [Revox::Models::AssistantCreateParams::Calendly]
       #
       #   @param call_retry_config [Revox::Models::AssistantCreateParams::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
       #

data/lib/revox/models/assistant_delete_params.rb

@@ -7,7 +7,13 @@ module Revox
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/revox/models/assistant_retrieve_params.rb

@@ -7,7 +7,13 @@ module Revox
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
       #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/revox/models/assistant_update_params.rb

@@ -7,6 +7,11 @@ module Revox
       extend Revox::Internal::Type::RequestParameters::Converter
       include Revox::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute background_sound
       #   The background sound to play during the call. Useful to give the impression that
       #   your AI agent is in an office, in the street, or anywhere else you want.
@@ -17,7 +22,7 @@ module Revox
       # @!attribute calendly
       #
       #   @return [Revox::Models::AssistantUpdateParams::Calendly, nil]
-      optional :calendly, -> { Revox::AssistantUpdateParams::Calendly }, nil?: true
+      optional :calendly, -> { Revox::AssistantUpdateParams::Calendly }
 
       # @!attribute call_retry_config
       #   Configuration for call retry behavior including time windows, delays, and max
@@ -125,13 +130,15 @@ module Revox
       #   @return [String, nil]
       optional :webhook_url, String
 
-      # @!method initialize(background_sound: nil, calendly: nil, call_retry_config: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, max_call_duration_secs: nil, name: nil, prompt: nil, structured_output_config: nil, transfer_phone_number: nil, voice: nil, voicemail_message: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(id:, background_sound: nil, calendly: nil, call_retry_config: nil, end_of_call_sentence: nil, faq_items: nil, first_sentence: nil, first_sentence_delay_ms: nil, first_sentence_mode: nil, ivr_navigation_enabled: nil, llm_model: nil, max_call_duration_secs: nil, name: nil, prompt: nil, structured_output_config: nil, transfer_phone_number: nil, voice: nil, voicemail_message: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Revox::Models::AssistantUpdateParams} for more details.
       #
+      #   @param id [String]
+      #
       #   @param background_sound [Symbol, Revox::Models::AssistantUpdateParams::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
       #
-      #   @param calendly [Revox::Models::AssistantUpdateParams::Calendly, nil]
+      #   @param calendly [Revox::Models::AssistantUpdateParams::Calendly]
       #
       #   @param call_retry_config [Revox::Models::AssistantUpdateParams::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
       #

data/lib/revox/models/call_create_params.rb

@@ -111,7 +111,7 @@ module Revox
         # @!attribute calendly
         #
         #   @return [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
-        optional :calendly, -> { Revox::CallCreateParams::Assistant::Calendly }, nil?: true
+        optional :calendly, -> { Revox::CallCreateParams::Assistant::Calendly }
 
         # @!attribute call_retry_config
         #   Configuration for call retry behavior including time windows, delays, and max
@@ -219,7 +219,7 @@ module Revox
         #
         #   @param background_sound [Symbol, Revox::Models::CallCreateParams::Assistant::BackgroundSound, nil] The background sound to play during the call. Useful to give the impression that
         #
-        #   @param calendly [Revox::Models::CallCreateParams::Assistant::Calendly, nil]
+        #   @param calendly [Revox::Models::CallCreateParams::Assistant::Calendly]
         #
         #   @param call_retry_config [Revox::Models::CallCreateParams::Assistant::CallRetryConfig] Configuration for call retry behavior including time windows, delays, and max it
         #