revox 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b4de98cd33754972b65ef99449f76c9078cde99b079302b8a7dab710f14d5e
-  data.tar.gz: d2c9bd5a34e61764f65a4152373865f0f4d408eea3c27f2e7163269bf02c559a
+  metadata.gz: 41aac7797615fd013e839d0c86fdfa4d91e63bf84aefd38a5dba8b5b21adaadb
+  data.tar.gz: e1debea088c862fc5e8fb25af0e3d3922c182b0f31bf68f39764b97daecc1474
 SHA512:
-  metadata.gz: 377e6d49e2bd561db5e07927c6bc6ac918f79c7ec04e9a420c2c2e529cd526b66336186265ec05b52d757d2bf6330676170515892e9295f67052db114485189f
-  data.tar.gz: 57474f614ce033b82000f7cbc94555b861c9bb806c588575ca833a35b036309de28b3453b2fda6bb3e06661679ece275a6ea8aab017f146ac738c04896ff3861
+  metadata.gz: 9d3560afab65ac8e1156b3a82795817bad62024de8e00571a39602e874aa4415c873ce1180339606bbe8120a524c5265f36622c59ec6a9414bed3e28293f96a5
+  data.tar.gz: a63fa996ca7d7a93725fd9d55c3f8169b84200e659a4cd48b3d533211414eb444f90025d5dfde9dc453d5a3d7981af1ac8fe07847366f415cd31de9d533e55af

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.5.0](https://github.com/revoxai/revox-ruby/compare/v0.4.0...v0.5.0) (2026-08-24)
+
+
+### Features
+
+* add campaigns.launch for starting campaign calls ([ac41a27](https://github.com/revoxai/revox-ruby/commit/ac41a279c94ddacab86ac8e5d0c79d6909b031f5))
+
 ## 0.4.0 (2026-08-21)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/revoxai/revox-ruby/compare/v0.3.0...v0.4.0)

data/README.md

@@ -8,8 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 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)
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40revoxai%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkByZXZveGFpL3Nkay1tY3AiXSwiZW52Ijp7IlJFVk9YX0FQSV9LRVkiOiJNeSBBUEkgS2V5In19)
+[![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%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40revoxai%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22REVOX_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
 
 > Note: You may need to set environment variables in your MCP client.
 
@@ -24,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.4.0"
+gem "revox", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->
@@ -262,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
-# :generated
-puts(Revox::AssistantCreateParams::FirstSentenceMode::GENERATED)
+# :ai_first
+puts(Revox::CampaignLaunchParams::Mode::AI_FIRST)
 
-# Revealed type: `T.all(Revox::AssistantCreateParams::FirstSentenceMode, Symbol)`
-T.reveal_type(Revox::AssistantCreateParams::FirstSentenceMode::GENERATED)
+# Revealed type: `T.all(Revox::CampaignLaunchParams::Mode, Symbol)`
+T.reveal_type(Revox::CampaignLaunchParams::Mode::AI_FIRST)
 ```
 
 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.launch(
+  mode: Revox::CampaignLaunchParams::Mode::AI_FIRST,
   # …
 )
 
 # Literal values are also permissible:
-revox.assistants.create(
-  first_sentence_mode: :generated,
+revox.campaigns.launch(
+  mode: :ai_first,
   # …
 )
 ```

data/lib/revox/models/campaign_launch_params.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Revox
+  module Models
+    # @see Revox::Resources::Campaigns#launch
+    class CampaignLaunchParams < Revox::Internal::Type::BaseModel
+      extend Revox::Internal::Type::RequestParameters::Converter
+      include Revox::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute mode
+      #
+      #   @return [Symbol, Revox::Models::CampaignLaunchParams::Mode]
+      required :mode, enum: -> { Revox::CampaignLaunchParams::Mode }
+
+      # @!attribute selection
+      #
+      #   @return [Revox::Models::CampaignLaunchParams::Selection]
+      required :selection, -> { Revox::CampaignLaunchParams::Selection }
+
+      # @!attribute scheduled_at
+      #   When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+      #   dial session cannot be scheduled.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time
+
+      # @!method initialize(id:, mode:, selection:, scheduled_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Revox::Models::CampaignLaunchParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param mode [Symbol, Revox::Models::CampaignLaunchParams::Mode]
+      #
+      #   @param selection [Revox::Models::CampaignLaunchParams::Selection]
+      #
+      #   @param scheduled_at [Time] When to place the calls (ISO 8601). Omit to launch now. ai_first only — a speed
+      #
+      #   @param request_options [Revox::RequestOptions, Hash{Symbol=>Object}]
+
+      module Mode
+        extend Revox::Internal::Type::Enum
+
+        AI_FIRST = :ai_first
+        SPEED_DIAL = :speed_dial
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Selection < Revox::Internal::Type::BaseModel
+        # @!attribute filters
+        #
+        #   @return [Revox::Models::CampaignLaunchParams::Selection::Filters]
+        required :filters, -> { Revox::CampaignLaunchParams::Selection::Filters }
+
+        # @!attribute rows
+        #
+        #   @return [Revox::Models::CampaignLaunchParams::Selection::Rows]
+        required :rows, -> { Revox::CampaignLaunchParams::Selection::Rows }
+
+        # @!method initialize(filters:, rows:)
+        #   @param filters [Revox::Models::CampaignLaunchParams::Selection::Filters]
+        #   @param rows [Revox::Models::CampaignLaunchParams::Selection::Rows]
+
+        # @see Revox::Models::CampaignLaunchParams::Selection#filters
+        class Filters < Revox::Internal::Type::BaseModel
+          # @!attribute assignee_ids
+          #
+          #   @return [Array<String>]
+          required :assignee_ids, Revox::Internal::Type::ArrayOf[String]
+
+          # @!attribute directions
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Direction>]
+          required :directions,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Direction] }
+
+          # @!attribute outcomes
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Outcome>]
+          required :outcomes,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Outcome] }
+
+          # @!attribute results
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Result>]
+          required :results,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Result] }
+
+          # @!attribute statuses
+          #
+          #   @return [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Status>]
+          required :statuses,
+                   -> { Revox::Internal::Type::ArrayOf[enum: Revox::CampaignLaunchParams::Selection::Filters::Status] }
+
+          # @!attribute query
+          #
+          #   @return [String, nil]
+          optional :query, String
+
+          # @!method initialize(assignee_ids:, directions:, outcomes:, results:, statuses:, query: nil)
+          #   @param assignee_ids [Array<String>]
+          #   @param directions [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Direction>]
+          #   @param outcomes [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Outcome>]
+          #   @param results [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Result>]
+          #   @param statuses [Array<Symbol, Revox::Models::CampaignLaunchParams::Selection::Filters::Status>]
+          #   @param query [String]
+
+          module Direction
+            extend Revox::Internal::Type::Enum
+
+            INBOUND = :inbound
+            OUTBOUND = :outbound
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module Outcome
+            extend Revox::Internal::Type::Enum
+
+            NOT_INTERESTED = :not_interested
+            INTERESTED = :interested
+            COMPLETED = :completed
+            REQUESTED_CALLBACK_LATER = :requested_callback_later
+            NONE = :none
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module Result
+            extend Revox::Internal::Type::Enum
+
+            IVR = :IVR
+            VOICEMAIL = :voicemail
+            HUMAN = :human
+            UNKNOWN = :unknown
+            IOS_SCREENING_FILTER = :"ios-screening-filter"
+            NONE = :none
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module Status
+            extend Revox::Internal::Type::Enum
+
+            INITIALIZING = :initializing
+            QUEUED_FOR_CALLING = :queued_for_calling
+            CALLING = :calling
+            POST_PROCESSING = :post_processing
+            NOT_LAUNCHED = :not_launched
+            SCHEDULED = :scheduled
+            PAUSED = :paused
+            COMPLETED = :completed
+            CANCELLED = :cancelled
+            ERRORED = :errored
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Revox::Models::CampaignLaunchParams::Selection#rows
+        class Rows < Revox::Internal::Type::BaseModel
+          # @!attribute call_ids
+          #
+          #   @return [Array<String>]
+          required :call_ids, Revox::Internal::Type::ArrayOf[String]
+
+          # @!attribute mode
+          #
+          #   @return [Symbol, Revox::Models::CampaignLaunchParams::Selection::Rows::Mode]
+          required :mode, enum: -> { Revox::CampaignLaunchParams::Selection::Rows::Mode }
+
+          # @!method initialize(call_ids:, mode:)
+          #   @param call_ids [Array<String>]
+          #   @param mode [Symbol, Revox::Models::CampaignLaunchParams::Selection::Rows::Mode]
+
+          # @see Revox::Models::CampaignLaunchParams::Selection::Rows#mode
+          module Mode
+            extend Revox::Internal::Type::Enum
+
+            ALL_EXCEPT = :all_except
+            ONLY = :only
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end