surge_api 0.23.0 → 0.25.0

data/sig/surge_api/models/user_create_token_params.rbs

@@ -1,7 +1,7 @@
 module SurgeAPI
   module Models
     type user_create_token_params =
-      { user_id: String, duration_seconds: Integer }
+      { user_id: String, duration_seconds: Integer, read_only: bool }
       & SurgeAPI::Internal::Type::request_parameters
 
     class UserCreateTokenParams < SurgeAPI::Internal::Type::BaseModel
@@ -14,15 +14,21 @@ module SurgeAPI
 
       def duration_seconds=: (Integer) -> Integer
 
+      attr_reader read_only: bool?
+
+      def read_only=: (bool) -> bool
+
       def initialize: (
         user_id: String,
         ?duration_seconds: Integer,
+        ?read_only: bool,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
         user_id: String,
         duration_seconds: Integer,
+        read_only: bool,
         request_options: SurgeAPI::RequestOptions
       }
     end

data/sig/surge_api/models.rbs

@@ -39,12 +39,18 @@ module SurgeAPI
 
   module CampaignParams = SurgeAPI::Models::CampaignParams
 
+  class CampaignRejectedWebhookEvent = SurgeAPI::Models::CampaignRejectedWebhookEvent
+
   class CampaignResendBrandVerificationMessageParams = SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
 
   class CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
 
+  class CampaignSubmittedWebhookEvent = SurgeAPI::Models::CampaignSubmittedWebhookEvent
+
   class CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
 
+  class CampaignWarningWebhookEvent = SurgeAPI::Models::CampaignWarningWebhookEvent
+
   class Contact = SurgeAPI::Models::Contact
 
   class ContactCreateParams = SurgeAPI::Models::ContactCreateParams
@@ -89,6 +95,8 @@ module SurgeAPI
 
   class PhoneNumberAttachedToCampaignWebhookEvent = SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent
 
+  class PhoneNumberImportedWebhookEvent = SurgeAPI::Models::PhoneNumberImportedWebhookEvent
+
   class PhoneNumberListAvailableNumbersParams = SurgeAPI::Models::PhoneNumberListAvailableNumbersParams
 
   class PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
@@ -111,6 +119,20 @@ module SurgeAPI
 
   class RecordingRetrieveParams = SurgeAPI::Models::RecordingRetrieveParams
 
+  class TollFreeCampaign = SurgeAPI::Models::TollFreeCampaign
+
+  module TollFreeCampaignConsentFlow = SurgeAPI::Models::TollFreeCampaignConsentFlow
+
+  class TollFreeCampaignCreateParams = SurgeAPI::Models::TollFreeCampaignCreateParams
+
+  class TollFreeCampaignListParams = SurgeAPI::Models::TollFreeCampaignListParams
+
+  class TollFreeCampaignParams = SurgeAPI::Models::TollFreeCampaignParams
+
+  class TollFreeCampaignRetrieveParams = SurgeAPI::Models::TollFreeCampaignRetrieveParams
+
+  class TollFreeCampaignUpdateParams = SurgeAPI::Models::TollFreeCampaignUpdateParams
+
   module UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   class User = SurgeAPI::Models::User

data/sig/surge_api/resources/campaigns.rbs

@@ -14,7 +14,15 @@ module SurgeAPI
 
       def update: (
         String id,
-        campaign_params: SurgeAPI::Models::campaign_params,
+        ?consent_flow: String,
+        ?description: String,
+        ?includes: ::Array[SurgeAPI::Models::CampaignUpdateParams::include_],
+        ?link_sample: String?,
+        ?message_samples: ::Array[String],
+        ?privacy_policy_url: String,
+        ?terms_and_conditions_url: String,
+        ?use_cases: ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case],
+        ?volume: SurgeAPI::Models::CampaignUpdateParams::volume,
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::Campaign
 

data/sig/surge_api/resources/phone_numbers.rbs

@@ -9,6 +9,7 @@ module SurgeAPI
       def update: (
         String id,
         ?campaign_id: String,
+        ?metadata: ::Hash[Symbol, String],
         ?name: String,
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::PhoneNumber
@@ -35,6 +36,7 @@ module SurgeAPI
         ?area_code: String,
         ?latitude: Float,
         ?longitude: Float,
+        ?metadata: ::Hash[Symbol, String],
         ?name: String,
         ?phone_number: String,
         ?type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,

data/sig/surge_api/resources/toll_free_campaigns.rbs

@@ -0,0 +1,44 @@
+module SurgeAPI
+  module Resources
+    class TollFreeCampaigns
+      def create: (
+        String account_id,
+        consent_flows: ::Array[SurgeAPI::Models::TollFreeCampaignParams::consent_flow],
+        description: String,
+        message_samples: ::Array[String],
+        phone_number_id: String,
+        privacy_policy_url: String,
+        terms_and_conditions_url: String,
+        use_cases: ::Array[SurgeAPI::Models::TollFreeCampaignParams::use_case],
+        ?includes: ::Array[SurgeAPI::Models::TollFreeCampaignParams::include_],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::TollFreeCampaign
+
+      def retrieve: (
+        String campaign_id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::TollFreeCampaign
+
+      def update: (
+        String campaign_id,
+        ?consent_flows: ::Array[SurgeAPI::Models::TollFreeCampaignUpdateParams::consent_flow],
+        ?description: String,
+        ?includes: ::Array[SurgeAPI::Models::TollFreeCampaignUpdateParams::include_],
+        ?message_samples: ::Array[String],
+        ?privacy_policy_url: String,
+        ?terms_and_conditions_url: String,
+        ?use_cases: ::Array[SurgeAPI::Models::TollFreeCampaignUpdateParams::use_case],
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::TollFreeCampaign
+
+      def list: (
+        String account_id,
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Internal::Cursor[SurgeAPI::TollFreeCampaign]
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/users.rbs

@@ -39,6 +39,7 @@ module SurgeAPI
       def create_token: (
         String user_id,
         ?duration_seconds: Integer,
+        ?read_only: bool,
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::UserTokenResponse
 

data/sig/surge_api/resources/webhooks.rbs

@@ -7,6 +7,9 @@ module SurgeAPI
         ?key: String?
       ) -> (SurgeAPI::CallEndedWebhookEvent
       | SurgeAPI::CampaignApprovedWebhookEvent
+      | SurgeAPI::CampaignRejectedWebhookEvent
+      | SurgeAPI::CampaignSubmittedWebhookEvent
+      | SurgeAPI::CampaignWarningWebhookEvent
       | SurgeAPI::ContactOptedInWebhookEvent
       | SurgeAPI::ContactOptedOutWebhookEvent
       | SurgeAPI::ConversationCreatedWebhookEvent
@@ -16,6 +19,7 @@ module SurgeAPI
       | SurgeAPI::MessageReceivedWebhookEvent
       | SurgeAPI::MessageSentWebhookEvent
       | SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent
+      | SurgeAPI::PhoneNumberImportedWebhookEvent
       | SurgeAPI::RecordingCompletedWebhookEvent
       | SurgeAPI::VoicemailReceivedWebhookEvent)
 

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Surge
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-19 00:00:00.000000000 Z
+date: 2026-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cgi
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: support@surge.app
 executables: []
 extensions: []
@@ -106,10 +118,13 @@ files:
 - lib/surge_api/models/campaign_create_params.rb
 - lib/surge_api/models/campaign_list_params.rb
 - lib/surge_api/models/campaign_params.rb
+- lib/surge_api/models/campaign_rejected_webhook_event.rb
 - lib/surge_api/models/campaign_resend_brand_verification_message_params.rb
 - lib/surge_api/models/campaign_resend_brand_verification_message_response.rb
 - lib/surge_api/models/campaign_retrieve_params.rb
+- lib/surge_api/models/campaign_submitted_webhook_event.rb
 - lib/surge_api/models/campaign_update_params.rb
+- lib/surge_api/models/campaign_warning_webhook_event.rb
 - lib/surge_api/models/contact.rb
 - lib/surge_api/models/contact_create_params.rb
 - lib/surge_api/models/contact_list_params.rb
@@ -132,6 +147,7 @@ files:
 - lib/surge_api/models/organization.rb
 - lib/surge_api/models/phone_number.rb
 - lib/surge_api/models/phone_number_attached_to_campaign_webhook_event.rb
+- lib/surge_api/models/phone_number_imported_webhook_event.rb
 - lib/surge_api/models/phone_number_list_available_numbers_params.rb
 - lib/surge_api/models/phone_number_list_available_numbers_response.rb
 - lib/surge_api/models/phone_number_list_params.rb
@@ -148,6 +164,13 @@ files:
 - lib/surge_api/models/recording_list_response.rb
 - lib/surge_api/models/recording_retrieve_params.rb
 - lib/surge_api/models/recording_retrieve_response.rb
+- lib/surge_api/models/toll_free_campaign.rb
+- lib/surge_api/models/toll_free_campaign_consent_flow.rb
+- lib/surge_api/models/toll_free_campaign_create_params.rb
+- lib/surge_api/models/toll_free_campaign_list_params.rb
+- lib/surge_api/models/toll_free_campaign_params.rb
+- lib/surge_api/models/toll_free_campaign_retrieve_params.rb
+- lib/surge_api/models/toll_free_campaign_update_params.rb
 - lib/surge_api/models/unwrap_webhook_event.rb
 - lib/surge_api/models/user.rb
 - lib/surge_api/models/user_create_params.rb
@@ -173,6 +196,7 @@ files:
 - lib/surge_api/resources/messages.rb
 - lib/surge_api/resources/phone_numbers.rb
 - lib/surge_api/resources/recordings.rb
+- lib/surge_api/resources/toll_free_campaigns.rb
 - lib/surge_api/resources/users.rb
 - lib/surge_api/resources/verifications.rb
 - lib/surge_api/resources/webhooks.rb
@@ -220,10 +244,13 @@ files:
 - rbi/surge_api/models/campaign_create_params.rbi
 - rbi/surge_api/models/campaign_list_params.rbi
 - rbi/surge_api/models/campaign_params.rbi
+- rbi/surge_api/models/campaign_rejected_webhook_event.rbi
 - rbi/surge_api/models/campaign_resend_brand_verification_message_params.rbi
 - rbi/surge_api/models/campaign_resend_brand_verification_message_response.rbi
 - rbi/surge_api/models/campaign_retrieve_params.rbi
+- rbi/surge_api/models/campaign_submitted_webhook_event.rbi
 - rbi/surge_api/models/campaign_update_params.rbi
+- rbi/surge_api/models/campaign_warning_webhook_event.rbi
 - rbi/surge_api/models/contact.rbi
 - rbi/surge_api/models/contact_create_params.rbi
 - rbi/surge_api/models/contact_list_params.rbi
@@ -246,6 +273,7 @@ files:
 - rbi/surge_api/models/organization.rbi
 - rbi/surge_api/models/phone_number.rbi
 - rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi
+- rbi/surge_api/models/phone_number_imported_webhook_event.rbi
 - rbi/surge_api/models/phone_number_list_available_numbers_params.rbi
 - rbi/surge_api/models/phone_number_list_available_numbers_response.rbi
 - rbi/surge_api/models/phone_number_list_params.rbi
@@ -262,6 +290,13 @@ files:
 - rbi/surge_api/models/recording_list_response.rbi
 - rbi/surge_api/models/recording_retrieve_params.rbi
 - rbi/surge_api/models/recording_retrieve_response.rbi
+- rbi/surge_api/models/toll_free_campaign.rbi
+- rbi/surge_api/models/toll_free_campaign_consent_flow.rbi
+- rbi/surge_api/models/toll_free_campaign_create_params.rbi
+- rbi/surge_api/models/toll_free_campaign_list_params.rbi
+- rbi/surge_api/models/toll_free_campaign_params.rbi
+- rbi/surge_api/models/toll_free_campaign_retrieve_params.rbi
+- rbi/surge_api/models/toll_free_campaign_update_params.rbi
 - rbi/surge_api/models/unwrap_webhook_event.rbi
 - rbi/surge_api/models/user.rbi
 - rbi/surge_api/models/user_create_params.rbi
@@ -287,6 +322,7 @@ files:
 - rbi/surge_api/resources/messages.rbi
 - rbi/surge_api/resources/phone_numbers.rbi
 - rbi/surge_api/resources/recordings.rbi
+- rbi/surge_api/resources/toll_free_campaigns.rbi
 - rbi/surge_api/resources/users.rbi
 - rbi/surge_api/resources/verifications.rbi
 - rbi/surge_api/resources/webhooks.rbi
@@ -333,10 +369,13 @@ files:
 - sig/surge_api/models/campaign_create_params.rbs
 - sig/surge_api/models/campaign_list_params.rbs
 - sig/surge_api/models/campaign_params.rbs
+- sig/surge_api/models/campaign_rejected_webhook_event.rbs
 - sig/surge_api/models/campaign_resend_brand_verification_message_params.rbs
 - sig/surge_api/models/campaign_resend_brand_verification_message_response.rbs
 - sig/surge_api/models/campaign_retrieve_params.rbs
+- sig/surge_api/models/campaign_submitted_webhook_event.rbs
 - sig/surge_api/models/campaign_update_params.rbs
+- sig/surge_api/models/campaign_warning_webhook_event.rbs
 - sig/surge_api/models/contact.rbs
 - sig/surge_api/models/contact_create_params.rbs
 - sig/surge_api/models/contact_list_params.rbs
@@ -359,6 +398,7 @@ files:
 - sig/surge_api/models/organization.rbs
 - sig/surge_api/models/phone_number.rbs
 - sig/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbs
+- sig/surge_api/models/phone_number_imported_webhook_event.rbs
 - sig/surge_api/models/phone_number_list_available_numbers_params.rbs
 - sig/surge_api/models/phone_number_list_available_numbers_response.rbs
 - sig/surge_api/models/phone_number_list_params.rbs
@@ -375,6 +415,13 @@ files:
 - sig/surge_api/models/recording_list_response.rbs
 - sig/surge_api/models/recording_retrieve_params.rbs
 - sig/surge_api/models/recording_retrieve_response.rbs
+- sig/surge_api/models/toll_free_campaign.rbs
+- sig/surge_api/models/toll_free_campaign_consent_flow.rbs
+- sig/surge_api/models/toll_free_campaign_create_params.rbs
+- sig/surge_api/models/toll_free_campaign_list_params.rbs
+- sig/surge_api/models/toll_free_campaign_params.rbs
+- sig/surge_api/models/toll_free_campaign_retrieve_params.rbs
+- sig/surge_api/models/toll_free_campaign_update_params.rbs
 - sig/surge_api/models/unwrap_webhook_event.rbs
 - sig/surge_api/models/user.rbs
 - sig/surge_api/models/user_create_params.rbs
@@ -400,6 +447,7 @@ files:
 - sig/surge_api/resources/messages.rbs
 - sig/surge_api/resources/phone_numbers.rbs
 - sig/surge_api/resources/recordings.rbs
+- sig/surge_api/resources/toll_free_campaigns.rbs
 - sig/surge_api/resources/users.rbs
 - sig/surge_api/resources/verifications.rbs
 - sig/surge_api/resources/webhooks.rbs
@@ -410,7 +458,6 @@ metadata:
   homepage_uri: https://gemdocs.org/gems/surge_api
   source_code_uri: https://github.com/surgeapi/ruby-sdk
   rubygems_mfa_required: 'false'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -425,8 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby library to access the Surge API
 test_files: []