surge_api 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5716cf1bf5c2e7a858c9c7a706c388a3a174518d8d1170c4254b5a813e7bd0d
-  data.tar.gz: 6a184865cd4ac3b7a8498431c2b229b64794624768f7e4782ad7d74b2d7b98e3
+  metadata.gz: c82e977c1b13f76e76cfdfc5b1923c25d8eb4c93d77004a725f23868a11235ce
+  data.tar.gz: c7a23b14a90c1f635c3e4c176e848ccccb5c067eb9a07562292212ea1eb30475
 SHA512:
-  metadata.gz: 4a2f8940ada65f353148d318d9167f83d25a145a766018d83245aa8fece4f6cb27d419f2ecf164e0a4a03b253a443cfcdd543ac0cdaaf55d01459d8ca87e6959
-  data.tar.gz: f65c4af57e2f91a1604c54b119285014d42beb0e070e98cf91610bb4a77b17bf1a7dc8246710d5f970a1c37661eed4e4413bb3caa9b0d505b49807765ed5ba47
+  metadata.gz: 7e04c8bbd80d9e18e0e71ad8b52f177d32e9ba2aa419d6ffb75ba59c7d00f1491eee23174e75869d3631520b6918f6c77a44f64e956ebd8cb021d80ede2c96cc
+  data.tar.gz: a329bf6f328a0c740e1b8d68f8e280e7486ea3c1102ccbb07f2f113c16aa8f34691a7891f5365f13b9412485d41340a5406986b3fb1802752fdc688ffc83375d

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.25.0](https://github.com/surgeapi/ruby-sdk/compare/v0.24.0...v0.25.0) (2026-10-29)
+
+
+### Features
+
+* update ruby SDK ([27806c1](https://github.com/surgeapi/ruby-sdk/commit/27806c1f6f9e0441c462ff72f95fae52d14b5bf1))
+
+
+### Bug Fixes
+
+* declare base64 as a runtime dependency ([f5a2435](https://github.com/surgeapi/ruby-sdk/commit/f5a2435d20809bb16fbfee02becb4e4621731841))
+
 ## 0.24.0 (2026-09-04)
 
 Full Changelog: [v0.23.0...v0.24.0](https://github.com/surgeapi/ruby-sdk/compare/v0.23.0...v0.24.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.24.0"
+gem "surge_api", "~> 0.25.0"
 ```
 
 <!-- x-release-please-end -->
@@ -260,25 +260,25 @@ surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", **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
-# :local
-puts(SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::LOCAL)
+# :high
+puts(SurgeAPI::CampaignUpdateParams::Volume::HIGH)
 
-# Revealed type: `T.all(SurgeAPI::PhoneNumberListAvailableNumbersParams::Type, Symbol)`
-T.reveal_type(SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::LOCAL)
+# Revealed type: `T.all(SurgeAPI::CampaignUpdateParams::Volume, Symbol)`
+T.reveal_type(SurgeAPI::CampaignUpdateParams::Volume::HIGH)
 ```
 
 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:
-surge.phone_numbers.list_available_numbers(
-  type: SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::LOCAL,
+surge.campaigns.update(
+  volume: SurgeAPI::CampaignUpdateParams::Volume::HIGH,
   # …
 )
 
 # Literal values are also permissible:
-surge.phone_numbers.list_available_numbers(
-  type: :local,
+surge.campaigns.update(
+  volume: :high,
   # …
 )
 ```

data/lib/surge_api/client.rb

@@ -48,6 +48,9 @@ module SurgeAPI
     # @return [SurgeAPI::Resources::Recordings]
     attr_reader :recordings
 
+    # @return [SurgeAPI::Resources::TollFreeCampaigns]
+    attr_reader :toll_free_campaigns
+
     # @return [SurgeAPI::Resources::Users]
     attr_reader :users
 
@@ -131,6 +134,7 @@ module SurgeAPI
       @messages = SurgeAPI::Resources::Messages.new(client: self)
       @phone_numbers = SurgeAPI::Resources::PhoneNumbers.new(client: self)
       @recordings = SurgeAPI::Resources::Recordings.new(client: self)
+      @toll_free_campaigns = SurgeAPI::Resources::TollFreeCampaigns.new(client: self)
       @users = SurgeAPI::Resources::Users.new(client: self)
       @verifications = SurgeAPI::Resources::Verifications.new(client: self)
       @webhooks = SurgeAPI::Resources::Webhooks.new(client: self)

data/lib/surge_api/internal/type/union.rb

@@ -12,7 +12,7 @@ module SurgeAPI
       #     puts(unwrap_webhook_event.account_id)
       #   when SurgeAPI::CampaignApprovedWebhookEvent
       #     puts(unwrap_webhook_event.data)
-      #   when SurgeAPI::ContactOptedInWebhookEvent
+      #   when SurgeAPI::CampaignRejectedWebhookEvent
       #     puts(unwrap_webhook_event.timestamp)
       #   else
       #     puts(unwrap_webhook_event)
@@ -24,7 +24,7 @@ module SurgeAPI
       #     puts(account_id)
       #   in {type: :"campaign.approved", account_id: account_id, data: data, timestamp: timestamp}
       #     puts(data)
-      #   in {type: :"contact.opted_in", account_id: account_id, data: data, timestamp: timestamp}
+      #   in {type: :"campaign.rejected", account_id: account_id, data: data, timestamp: timestamp}
       #     puts(timestamp)
       #   else
       #     puts(unwrap_webhook_event)

data/lib/surge_api/models/call_ended_webhook_event.rb

@@ -63,7 +63,8 @@ module SurgeAPI
         required :initiated_at, Time
 
         # @!attribute status
-        #   The status of the call
+        #   The status of the call. For inbound embedded-phone calls, `no_answer` means no
+        #   embedded user answered, even if the caller reached voicemail.
         #
         #   @return [Symbol, SurgeAPI::Models::CallEndedWebhookEvent::Data::Status]
         required :status, enum: -> { SurgeAPI::CallEndedWebhookEvent::Data::Status }
@@ -87,6 +88,9 @@ module SurgeAPI
         optional :to, String, nil?: true
 
         # @!method initialize(id:, contact:, duration:, initiated_at:, status:, from: nil, phone_number_id: nil, to: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::CallEndedWebhookEvent::Data} for more details.
+        #
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the call
@@ -97,7 +101,7 @@ module SurgeAPI
         #
         #   @param initiated_at [Time] When the call was initiated
         #
-        #   @param status [Symbol, SurgeAPI::Models::CallEndedWebhookEvent::Data::Status] The status of the call
+        #   @param status [Symbol, SurgeAPI::Models::CallEndedWebhookEvent::Data::Status] The status of the call. For inbound embedded-phone calls, `no_answer` means no e
         #
         #   @param from [String, nil] The E.164 phone number of the caller
         #
@@ -105,7 +109,8 @@ module SurgeAPI
         #
         #   @param to [String, nil] The E.164 phone number of the callee
 
-        # The status of the call
+        # The status of the call. For inbound embedded-phone calls, `no_answer` means no
+        # embedded user answered, even if the caller reached voicemail.
         #
         # @see SurgeAPI::Models::CallEndedWebhookEvent::Data#status
         module Status

data/lib/surge_api/models/campaign.rb

@@ -10,6 +10,12 @@ module SurgeAPI
       #   @return [String]
       required :id, String
 
+      # @!attribute account_id
+      #   The ID of the account that owns this campaign
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute consent_flow
       #   A string explaining the method through which end users will opt in to receive
       #   messages from the brand. Typically this should include URLs for opt-in forms or
@@ -101,11 +107,11 @@ module SurgeAPI
       #   This will be one of the following:
       #
       #   - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-      #     T-Mobile customers each day. In this case your platform will be charged for
-      #     the setup fee for a low volume number upon receipt of the API request.
+      #     T-Mobile customers each day. In this case your project will be charged for the
+      #     setup fee for a low volume number upon receipt of the API request.
       #   - `high` - The campaign will be allowed to send up to 200k SMS segments to
       #     T-Mobile customers each day, depending on the trust score assigned by The
-      #     Campaign Registry. Your platform will be charged for the setup fee for a high
+      #     Campaign Registry. Your project will be charged for the setup fee for a high
       #     volume number upon receipt of the API request, and phone numbers will be
       #     charged as high volume numbers going forward.
       #
@@ -130,7 +136,7 @@ module SurgeAPI
       #   @return [String, nil]
       optional :terms_and_conditions_url, String
 
-      # @!method initialize(id:, consent_flow:, description:, includes:, message_samples:, privacy_policy_url:, status:, use_cases:, volume:, link_sample: nil, terms_and_conditions_url: nil)
+      # @!method initialize(id:, account_id:, consent_flow:, description:, includes:, message_samples:, privacy_policy_url:, status:, use_cases:, volume:, link_sample: nil, terms_and_conditions_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::Campaign} for more details.
       #
@@ -139,6 +145,8 @@ module SurgeAPI
       #
       #   @param id [String] The campaign ID
       #
+      #   @param account_id [String] The ID of the account that owns this campaign
+      #
       #   @param consent_flow [String] A string explaining the method through which end users will opt in to receive me
       #
       #   @param description [String] An explanation of the organization's purpose and how it will be using text messa
@@ -209,11 +217,11 @@ module SurgeAPI
       # This will be one of the following:
       #
       # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-      #   T-Mobile customers each day. In this case your platform will be charged for
-      #   the setup fee for a low volume number upon receipt of the API request.
+      #   T-Mobile customers each day. In this case your project will be charged for the
+      #   setup fee for a low volume number upon receipt of the API request.
       # - `high` - The campaign will be allowed to send up to 200k SMS segments to
       #   T-Mobile customers each day, depending on the trust score assigned by The
-      #   Campaign Registry. Your platform will be charged for the setup fee for a high
+      #   Campaign Registry. Your project will be charged for the setup fee for a high
       #   volume number upon receipt of the API request, and phone numbers will be
       #   charged as high volume numbers going forward.
       #

data/lib/surge_api/models/campaign_approved_webhook_event.rb

@@ -44,17 +44,25 @@ module SurgeAPI
         #   @return [String]
         required :id, String
 
+        # @!attribute account_id
+        #   The ID of the account that owns this campaign
+        #
+        #   @return [String]
+        required :account_id, String
+
         # @!attribute status
         #   The status of the campaign. Will always be `active` for this event.
         #
         #   @return [Symbol, SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::Status]
         required :status, enum: -> { SurgeAPI::CampaignApprovedWebhookEvent::Data::Status }
 
-        # @!method initialize(id:, status:)
+        # @!method initialize(id:, account_id:, status:)
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the campaign
         #
+        #   @param account_id [String] The ID of the account that owns this campaign
+        #
         #   @param status [Symbol, SurgeAPI::Models::CampaignApprovedWebhookEvent::Data::Status] The status of the campaign. Will always be `active` for this event.
 
         # The status of the campaign. Will always be `active` for this event.

data/lib/surge_api/models/campaign_params.rb

@@ -95,11 +95,11 @@ module SurgeAPI
         #   This will be one of the following:
         #
         #   - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-        #     T-Mobile customers each day. In this case your platform will be charged for
-        #     the setup fee for a low volume number upon receipt of the API request.
+        #     T-Mobile customers each day. In this case your project will be charged for the
+        #     setup fee for a low volume number upon receipt of the API request.
         #   - `high` - The campaign will be allowed to send up to 200k SMS segments to
         #     T-Mobile customers each day, depending on the trust score assigned by The
-        #     Campaign Registry. Your platform will be charged for the setup fee for a high
+        #     Campaign Registry. Your project will be charged for the setup fee for a high
         #     volume number upon receipt of the API request, and phone numbers will be
         #     charged as high volume numbers going forward.
         #
@@ -175,11 +175,11 @@ module SurgeAPI
         # This will be one of the following:
         #
         # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-        #   T-Mobile customers each day. In this case your platform will be charged for
-        #   the setup fee for a low volume number upon receipt of the API request.
+        #   T-Mobile customers each day. In this case your project will be charged for the
+        #   setup fee for a low volume number upon receipt of the API request.
         # - `high` - The campaign will be allowed to send up to 200k SMS segments to
         #   T-Mobile customers each day, depending on the trust score assigned by The
-        #   Campaign Registry. Your platform will be charged for the setup fee for a high
+        #   Campaign Registry. Your project will be charged for the setup fee for a high
         #   volume number upon receipt of the API request, and phone numbers will be
         #   charged as high volume numbers going forward.
         #

data/lib/surge_api/models/campaign_rejected_webhook_event.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class CampaignRejectedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::CampaignRejectedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::CampaignRejectedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `campaign.rejected` for this event.
+      #
+      #   @return [Symbol, :"campaign.rejected"]
+      required :type, const: :"campaign.rejected"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"campaign.rejected")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::CampaignRejectedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"campaign.rejected"] The type of the event. Always `campaign.rejected` for this event.
+
+      # @see SurgeAPI::Models::CampaignRejectedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the campaign
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute feedback
+        #   Customer-visible field-level registration feedback. Rejection events may include
+        #   non-blocking warnings alongside changes-needed items.
+        #
+        #   @return [Array<SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Feedback>]
+        required :feedback,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback] }
+
+        # @!attribute status
+        #   The public campaign status. Always `rejected` for this event.
+        #
+        #   @return [Symbol, SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::CampaignRejectedWebhookEvent::Data::Status }
+
+        # @!method initialize(id:, feedback:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::CampaignRejectedWebhookEvent::Data} for more details.
+        #
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the campaign
+        #
+        #   @param feedback [Array<SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Feedback>] Customer-visible field-level registration feedback. Rejection events may include
+        #
+        #   @param status [Symbol, SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Status] The public campaign status. Always `rejected` for this event.
+
+        class Feedback < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute field
+          #   The stable registration field key
+          #
+          #   @return [String]
+          required :field, String
+
+          # @!attribute message
+          #   Actionable review feedback
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute outcome
+          #   Whether the feedback blocks registration or is a non-blocking warning
+          #
+          #   @return [Symbol, SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Feedback::Outcome]
+          required :outcome, enum: -> { SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome }
+
+          # @!attribute suggested_value
+          #   A suggested replacement value, or null when none is suggested
+          #
+          #   @return [String, nil]
+          required :suggested_value, String, nil?: true
+
+          # @!method initialize(field:, message:, outcome:, suggested_value:)
+          #   @param field [String] The stable registration field key
+          #
+          #   @param message [String] Actionable review feedback
+          #
+          #   @param outcome [Symbol, SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Feedback::Outcome] Whether the feedback blocks registration or is a non-blocking warning
+          #
+          #   @param suggested_value [String, nil] A suggested replacement value, or null when none is suggested
+
+          # Whether the feedback blocks registration or is a non-blocking warning
+          #
+          # @see SurgeAPI::Models::CampaignRejectedWebhookEvent::Data::Feedback#outcome
+          module Outcome
+            extend SurgeAPI::Internal::Type::Enum
+
+            CHANGES_NEEDED = :changes_needed
+            WARNING = :warning
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The public campaign status. Always `rejected` for this event.
+        #
+        # @see SurgeAPI::Models::CampaignRejectedWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/campaign_submitted_webhook_event.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class CampaignSubmittedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::CampaignSubmittedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `campaign.submitted` for this event.
+      #
+      #   @return [Symbol, :"campaign.submitted"]
+      required :type, const: :"campaign.submitted"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"campaign.submitted")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"campaign.submitted"] The type of the event. Always `campaign.submitted` for this event.
+
+      # @see SurgeAPI::Models::CampaignSubmittedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the campaign
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The public campaign status. Always `in_review` for this event.
+        #
+        #   @return [Symbol, SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status }
+
+        # @!method initialize(id:, status:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the campaign
+        #
+        #   @param status [Symbol, SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::Status] The public campaign status. Always `in_review` for this event.
+
+        # The public campaign status. Always `in_review` for this event.
+        #
+        # @see SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          IN_REVIEW = :in_review
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end