revox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665d2197b2774b34796d5e9acd358118f3148e7711386209395d3cbf7bc6b36c
-  data.tar.gz: 9053cc3a625b2164be340a4cf0b305ea4fa3cfc701ff7234780f2d4bbd58b2e0
+  metadata.gz: 8049f2cfd29f2b0b6a033f073e9c827b037fef2cc88d401a346bde3a52173c08
+  data.tar.gz: d4af5e75bc76ba13ba56f86ba56e5f2daf96d3c77a6113988b8b02f4f322217e
 SHA512:
-  metadata.gz: f89828b3e79ed23b2dca0a18a53f73a23212202dba7c96e5c30e0b171a62badc763aa6a293798c3405c0c39aec25133bd1d5cd8a802c8c8e613554ecd3b412b5
-  data.tar.gz: 572fed5f3e6e978f6839c0671a02972d60d151ce9c84731b4398ffb08334240c060eb6014e9e882e789e6e65ed61a75bed763e85b8c91df56657b2546223ab09
+  metadata.gz: c0c51795ea8733fc8abb5357d5602a497598e56791b11a648c5d3c623ca0a9d320a9535709c966a13c059d4297af3605dd5b25c118b8b11604707846649dd58f
+  data.tar.gz: bd43d8479786f0e3e77814fd88977b47132b0c0dca1082e4a0b1f77e53c312b18e46c1b40a4d6ef31e93d017909cde93d6827fbea020a26aa361307cb82d5741

data/CHANGELOG.md

@@ -1,5 +1,76 @@
 # Changelog
 
+## 0.2.0 (2026-07-15)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/revoxai/revox-ruby/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** api update ([8d240fd](https://github.com/revoxai/revox-ruby/commit/8d240fd35dc183da20d0247a33a0c6582b5db2db))
+* **api:** api update ([9869b36](https://github.com/revoxai/revox-ruby/commit/9869b369d43989b2995febe9b198b1b604f33d8b))
+* **api:** api update ([bf56a5b](https://github.com/revoxai/revox-ruby/commit/bf56a5bd81e2193a2eb43da9b946cb7a9b3603b1))
+* **api:** api update ([112fcd3](https://github.com/revoxai/revox-ruby/commit/112fcd3dcf9982385791fd1168bab051745d0dd7))
+* **api:** api update ([f5df56d](https://github.com/revoxai/revox-ruby/commit/f5df56da8ace157558e6947038496d43dab68af1))
+* **api:** api update ([a7c53f8](https://github.com/revoxai/revox-ruby/commit/a7c53f83552e293123cbf007fb4968bbcf3d49a9))
+* **api:** api update ([b513a69](https://github.com/revoxai/revox-ruby/commit/b513a69717d58eaf5c58b9bc1fb9a4d2eca40ad4))
+* **api:** api update ([dddd00e](https://github.com/revoxai/revox-ruby/commit/dddd00e1b4341c123d49ea76573ae366ebc4516c))
+* **api:** api update ([cde9973](https://github.com/revoxai/revox-ruby/commit/cde997321aa9ff51c1974e5cad84f1318870d235))
+* **api:** api update ([5763976](https://github.com/revoxai/revox-ruby/commit/57639762cfe583bc79138ce9b023f42bf7038287))
+* **api:** api update ([d666984](https://github.com/revoxai/revox-ruby/commit/d66698403b95d717d22db5f3aa7f1310f123c333))
+* **api:** api update ([ca78762](https://github.com/revoxai/revox-ruby/commit/ca78762207935c2aaf2dad44836d310f744cdb40))
+* **api:** api update ([cca54ce](https://github.com/revoxai/revox-ruby/commit/cca54ce1442922c21bfacc4ff0b15083c3b2d299))
+* **api:** api update ([44f5157](https://github.com/revoxai/revox-ruby/commit/44f5157ef688fedba8214ae20bc0b10d38915bb7))
+* **api:** api update ([ce7732a](https://github.com/revoxai/revox-ruby/commit/ce7732a68adef161474be5a89d59098522569408))
+* **api:** api update ([05f0099](https://github.com/revoxai/revox-ruby/commit/05f0099da266211d30eb80ec4a3fc156d95f39d7))
+* **api:** api update ([479acad](https://github.com/revoxai/revox-ruby/commit/479acad28f2524d1d3704442051fab3699a799cf))
+* **api:** api update ([c56b37b](https://github.com/revoxai/revox-ruby/commit/c56b37b31501d7c2e6011df204ecacf4101b65b6))
+* **api:** api update ([502e3cc](https://github.com/revoxai/revox-ruby/commit/502e3cca917fbab0044e6dabbcced3e4ba855e7e))
+* **api:** api update ([3fbceb1](https://github.com/revoxai/revox-ruby/commit/3fbceb15567d3e619e3d67dcb2a2d4590476744c))
+* **api:** api update ([d6283f7](https://github.com/revoxai/revox-ruby/commit/d6283f75a22b6df40ff16627973e8bb48233eb7f))
+* **api:** api update ([7d52591](https://github.com/revoxai/revox-ruby/commit/7d5259112e7bf7527f85d20538e0cd5369c5f885))
+* **api:** api update ([91f11fe](https://github.com/revoxai/revox-ruby/commit/91f11fea2ef847f8580f8b24595d891047ac0e02))
+* **api:** api update ([6c778a4](https://github.com/revoxai/revox-ruby/commit/6c778a48d14822330ad9c068b79ba62222eb8547))
+* **api:** api update ([0b8dc76](https://github.com/revoxai/revox-ruby/commit/0b8dc76c64992e49d67392a993cf3e518d449c59))
+* **api:** api update ([3881854](https://github.com/revoxai/revox-ruby/commit/3881854b74cac11c732ac8770c8fedf9977aceb5))
+* **api:** api update ([c160447](https://github.com/revoxai/revox-ruby/commit/c16044750e3c229cd5ff5731da1b36e7f3ce0911))
+* **api:** api update ([2dd7e29](https://github.com/revoxai/revox-ruby/commit/2dd7e29c003c94e1a8fc54150ed018dee6fed4de))
+* **api:** api update ([bcbccec](https://github.com/revoxai/revox-ruby/commit/bcbccecae3495b6167ea7b6a65270876b51c89e9))
+* **api:** api update ([abce6d8](https://github.com/revoxai/revox-ruby/commit/abce6d8a69e93b724c4dd20c85e478c5f7a4bfc4))
+* **api:** api update ([15e065f](https://github.com/revoxai/revox-ruby/commit/15e065f097f616b859c791b2d7308292be644c1e))
+* **api:** api update ([90a90e5](https://github.com/revoxai/revox-ruby/commit/90a90e51673ff39e3eaa82ff1d1f34000e47ad0a))
+* **api:** api update ([50bed77](https://github.com/revoxai/revox-ruby/commit/50bed77d93f041ec736e1f655bccd51acea5cf28))
+* **api:** api update ([4d644b1](https://github.com/revoxai/revox-ruby/commit/4d644b1170d8fc3eaf3c612a7466badef78bb08e))
+* **api:** api update ([06f4b29](https://github.com/revoxai/revox-ruby/commit/06f4b296792c0b210eb7bd3306ebbc135ae92da3))
+* **api:** api update ([4aa4421](https://github.com/revoxai/revox-ruby/commit/4aa44212415460e534dda3f198087d2ce5a95827))
+* **api:** api update ([0613739](https://github.com/revoxai/revox-ruby/commit/0613739387759e50815d005e58abc7f00ed85ac6))
+* **api:** api update ([9869a45](https://github.com/revoxai/revox-ruby/commit/9869a4559dce66130f9929a24fb57332a89a99e4))
+* **api:** api update ([1380dfb](https://github.com/revoxai/revox-ruby/commit/1380dfbc958d5f9b4ff72b3362d883c6509e7aa5))
+* **api:** api update ([53ff933](https://github.com/revoxai/revox-ruby/commit/53ff9331c97f09223c69cb2de7dab148b478f36d))
+* **api:** api update ([31b7dfe](https://github.com/revoxai/revox-ruby/commit/31b7dfe97b9c31e2549961ad0cc963f33976fe46))
+* **api:** api update ([446753b](https://github.com/revoxai/revox-ruby/commit/446753b7dca2c432116d5d90b2e6914ae09d6a4c))
+* support setting headers via env ([b4924cb](https://github.com/revoxai/revox-ruby/commit/b4924cb118f746f48dd79a6aec93e38d985f8f72))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([12227d4](https://github.com/revoxai/revox-ruby/commit/12227d4d3b83941377114ff2f66ae8238a76c733))
+* **client:** elide content type header on requests without body ([b066b04](https://github.com/revoxai/revox-ruby/commit/b066b049ed1abb7f0dad50b4655d869a93b0903f))
+* **client:** send content-type header for requests with an omitted optional body ([d66d881](https://github.com/revoxai/revox-ruby/commit/d66d881b34056e539370711607d3cbc1a750a597))
+* **internal:** correct multipart form field name encoding ([aad53d6](https://github.com/revoxai/revox-ruby/commit/aad53d61705ebb6f8787c539f5fea50591872394))
+* multipart encoding for file arrays ([41edad7](https://github.com/revoxai/revox-ruby/commit/41edad7843f71bd02744d02326363a1aa766c9a7))
+* variable name typo ([001a5e9](https://github.com/revoxai/revox-ruby/commit/001a5e9e03531812acaa8cff9544d85c5339b042))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([38ff917](https://github.com/revoxai/revox-ruby/commit/38ff917c34e21ea87963b6a0e0d63e71a2a327a5))
+* **ci:** support opting out of skipping builds on metadata-only commits ([bd897b8](https://github.com/revoxai/revox-ruby/commit/bd897b816c651cbc299e8936f8f722353b9d7495))
+* configure new SDK language ([7966f1a](https://github.com/revoxai/revox-ruby/commit/7966f1a260dc020f620a46a11b3bc72085dd4b4f))
+* **internal:** bound formatter parallelism to CPU count ([f159e56](https://github.com/revoxai/revox-ruby/commit/f159e567d712775a9f812692efd6bd51fe6874b4))
+* **internal:** more robust bootstrap script ([b1b49f1](https://github.com/revoxai/revox-ruby/commit/b1b49f14eeaaa9a9fc609d651ee51c408d7d1219))
+* **internal:** tweak CI branches ([cbb8d65](https://github.com/revoxai/revox-ruby/commit/cbb8d6531f3319c56ed3bd2a7411fae875815b42))
+* **internal:** update gitignore ([1327cee](https://github.com/revoxai/revox-ruby/commit/1327ceea6b00fb9dc9879cc242147a2ba4bd12a1))
+
 ## 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)

data/README.md

@@ -4,6 +4,15 @@ The Revox Ruby library provides convenient access to the Revox REST API from any
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Revox MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40revoxai%2Fsdk-mcp&config=eyJuYW1lIjoiQHJldm94YWkvc2RrLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL3Jldm94LW1jcC5zdGxtY3AuY29tIiwiaGVhZGVycyI6eyJ4LXJldm94LWFwaS1rZXkiOiJNeSBBUEkgS2V5In19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40revoxai%2Fsdk-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Frevox-mcp.stlmcp.com%22%2C%22headers%22%3A%7B%22x-revox-api-key%22%3A%22My%20API%20Key%22%7D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/revox).
@@ -15,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "revox", "~> 0.1.0"
+gem "revox", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->
@@ -33,7 +42,9 @@ revox = Revox::Client.new(
 campaign = revox.campaigns.create(
   assistant_id: "REPLACE_ME",
   contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
-  name: "REPLACE_ME"
+  launch: true,
+  name: "REPLACE_ME",
+  type: "regular"
 )
 
 puts(campaign.campaign)
@@ -48,7 +59,9 @@ begin
   campaign = revox.campaigns.create(
     assistant_id: "REPLACE_ME",
     contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
-    name: "REPLACE_ME"
+    launch: true,
+    name: "REPLACE_ME",
+    type: "regular"
   )
 rescue Revox::Errors::APIConnectionError => e
   puts("The server could not be reached")
@@ -95,7 +108,9 @@ revox = Revox::Client.new(
 revox.campaigns.create(
   assistant_id: "REPLACE_ME",
   contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  launch: true,
   name: "REPLACE_ME",
+  type: "regular",
   request_options: {max_retries: 5}
 )
 ```
@@ -114,7 +129,9 @@ revox = Revox::Client.new(
 revox.campaigns.create(
   assistant_id: "REPLACE_ME",
   contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+  launch: true,
   name: "REPLACE_ME",
+  type: "regular",
   request_options: {timeout: 5}
 )
 ```
@@ -150,7 +167,9 @@ campaign =
   revox.campaigns.create(
     assistant_id: "REPLACE_ME",
     contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
+    launch: true,
     name: "REPLACE_ME",
+    type: "regular",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -204,7 +223,9 @@ revox.campaigns.create(
       to_phone_number: "to_phone_number"
     )
   ],
-  name: "REPLACE_ME"
+  launch: true,
+  name: "REPLACE_ME",
+  type: "regular"
 )
 ```
 
@@ -215,7 +236,9 @@ Or, equivalently:
 revox.campaigns.create(
   assistant_id: "REPLACE_ME",
   contacts: [{prompt_variables: {foo: "string"}, to_phone_number: "to_phone_number"}],
-  name: "REPLACE_ME"
+  launch: true,
+  name: "REPLACE_ME",
+  type: "regular"
 )
 
 # You can also splat a full Params class:
@@ -227,7 +250,9 @@ params = Revox::CampaignCreateParams.new(
       to_phone_number: "to_phone_number"
     )
   ],
-  name: "REPLACE_ME"
+  launch: true,
+  name: "REPLACE_ME",
+  type: "regular"
 )
 revox.campaigns.create(**params)
 ```
@@ -237,25 +262,25 @@ revox.campaigns.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
-# :IVR
-puts(Revox::CampaignGetRowsParams::Result::IVR)
+# :regular
+puts(Revox::CampaignCreateParams::Type::REGULAR)
 
-# Revealed type: `T.all(Revox::CampaignGetRowsParams::Result, Symbol)`
-T.reveal_type(Revox::CampaignGetRowsParams::Result::IVR)
+# Revealed type: `T.all(Revox::CampaignCreateParams::Type, Symbol)`
+T.reveal_type(Revox::CampaignCreateParams::Type::REGULAR)
 ```
 
 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.campaigns.get_rows(
-  result: Revox::CampaignGetRowsParams::Result::IVR,
+revox.campaigns.create(
+  type: Revox::CampaignCreateParams::Type::REGULAR,
   # …
 )
 
 # Literal values are also permissible:
-revox.campaigns.get_rows(
-  result: :IVR,
+revox.campaigns.create(
+  type: :regular,
   # …
 )
 ```

data/lib/revox/client.rb

@@ -70,6 +70,19 @@ module Revox
         raise ArgumentError.new("api_key is required, and can be set via environ: \"REVOX_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["REVOX_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
 
       super(
@@ -77,7 +90,8 @@ module Revox
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @campaigns = Revox::Resources::Campaigns.new(client: self)

data/lib/revox/internal/transport/base_client.rb

@@ -306,6 +306,11 @@ module Revox
               Revox::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = Revox::Internal::Util.join_parsed_uri(@base_url_components, {**req, path: path, query: query})
           headers, encoded = Revox::Internal::Util.encode_content(headers, body)
           {

data/lib/revox/internal/util.rb

@@ -157,7 +157,7 @@ module Revox
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Revox::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Revox::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module Revox
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module Revox
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Revox::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module Revox
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module Revox
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in Revox::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module Revox
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module Revox
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Revox::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module Revox
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private