surge_api 0.23.0 → 0.25.0

data/lib/surge_api/models.rb

@@ -79,13 +79,19 @@ module SurgeAPI
 
   CampaignParams = SurgeAPI::Models::CampaignParams
 
+  CampaignRejectedWebhookEvent = SurgeAPI::Models::CampaignRejectedWebhookEvent
+
   CampaignResendBrandVerificationMessageParams =
     SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
 
   CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
 
+  CampaignSubmittedWebhookEvent = SurgeAPI::Models::CampaignSubmittedWebhookEvent
+
   CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
 
+  CampaignWarningWebhookEvent = SurgeAPI::Models::CampaignWarningWebhookEvent
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
@@ -130,6 +136,8 @@ module SurgeAPI
 
   PhoneNumberAttachedToCampaignWebhookEvent = SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent
 
+  PhoneNumberImportedWebhookEvent = SurgeAPI::Models::PhoneNumberImportedWebhookEvent
+
   PhoneNumberListAvailableNumbersParams = SurgeAPI::Models::PhoneNumberListAvailableNumbersParams
 
   PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
@@ -152,6 +160,20 @@ module SurgeAPI
 
   RecordingRetrieveParams = SurgeAPI::Models::RecordingRetrieveParams
 
+  TollFreeCampaign = SurgeAPI::Models::TollFreeCampaign
+
+  TollFreeCampaignConsentFlow = SurgeAPI::Models::TollFreeCampaignConsentFlow
+
+  TollFreeCampaignCreateParams = SurgeAPI::Models::TollFreeCampaignCreateParams
+
+  TollFreeCampaignListParams = SurgeAPI::Models::TollFreeCampaignListParams
+
+  TollFreeCampaignParams = SurgeAPI::Models::TollFreeCampaignParams
+
+  TollFreeCampaignRetrieveParams = SurgeAPI::Models::TollFreeCampaignRetrieveParams
+
+  TollFreeCampaignUpdateParams = SurgeAPI::Models::TollFreeCampaignUpdateParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User

data/lib/surge_api/resources/accounts.rb

@@ -6,7 +6,7 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::AccountCreateParams} for more details.
       #
-      # Creates a new Account within the calling Platform.
+      # Creates a new Account.
       #
       # @overload create(name:, brand_name: nil, organization: nil, time_zone: nil, request_options: {})
       #
@@ -90,7 +90,7 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::AccountListParams} for more details.
       #
-      # List all accounts for the calling platform with cursor-based pagination.
+      # List all accounts with cursor-based pagination.
       #
       # @overload list(after: nil, before: nil, request_options: {})
       #

data/lib/surge_api/resources/campaigns.rb

@@ -53,28 +53,46 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::CampaignUpdateParams} for more details.
       #
-      # Updates a campaign that has not yet been approved. This can be used to fix
-      # issues flagged during review and resubmit the campaign. Returns an error if the
-      # campaign is currently in review, has already been approved, or has been
-      # deactivated.
+      # Updates supplied fields on a campaign and submits it for review. Omitted fields
+      # retain their stored values. An empty object or empty request body resubmits the
+      # existing campaign without changing its registration details. Supplied arrays
+      # replace their stored values; an empty includes array clears all inclusion flags.
+      # Returns an error if the resulting campaign is incomplete or invalid, or the
+      # campaign is not editable.
       #
-      # @overload update(id, campaign_params:, request_options: {})
+      # @overload update(id, consent_flow: nil, description: nil, includes: nil, link_sample: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil, volume: nil, request_options: {})
       #
       # @param id [String] The ID of the campaign to update.
       #
-      # @param campaign_params [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
+      # @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
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::Include>] A list of properties that this campaign should include. These properties can be
+      #
+      # @param link_sample [String, nil] A sample link that might be sent by this campaign. This is required when `includ
+      #
+      # @param message_samples [Array<String>] An array of 2-5 strings with examples of the messages that will be sent from thi
+      #
+      # @param privacy_policy_url [String] The URL of the privacy policy for the brand in question. This may be a shared pr
+      #
+      # @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+      #
+      # @param volume [Symbol, SurgeAPI::Models::CampaignUpdateParams::Volume] This will be one of the following:
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [SurgeAPI::Models::Campaign]
       #
       # @see SurgeAPI::Models::CampaignUpdateParams
-      def update(id, params)
+      def update(id, params = {})
         parsed, options = SurgeAPI::CampaignUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["campaigns/%1$s", id],
-          body: parsed[:campaign_params],
+          body: parsed,
           model: SurgeAPI::Campaign,
           options: options
         )

data/lib/surge_api/resources/phone_numbers.rb

@@ -25,12 +25,14 @@ module SurgeAPI
 
       # Updates a phone number's details.
       #
-      # @overload update(id, campaign_id: nil, name: nil, request_options: {})
+      # @overload update(id, campaign_id: nil, metadata: nil, name: nil, request_options: {})
       #
       # @param id [String] The ID of the phone number to update.
       #
       # @param campaign_id [String] Campaign ID to attach this number to (`cpn_...`).
       #
+      # @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       # @param name [String] A human-readable name for the phone number.
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -127,7 +129,7 @@ module SurgeAPI
       #
       # When `phone_number` is provided, all other search parameters are ignored.
       #
-      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, name: nil, phone_number: nil, type: nil, request_options: {})
+      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, metadata: nil, name: nil, phone_number: nil, type: nil, request_options: {})
       #
       # @param account_id [String] The account for which the phone number should be created.
       #
@@ -137,6 +139,8 @@ module SurgeAPI
       #
       # @param longitude [Float] Longitude to search for nearby phone numbers. Must be used with latitude. If pro
       #
+      # @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       # @param name [String] A human-readable name for the phone number. If not provided, defaults to the for
       #
       # @param phone_number [String] The exact phone number to purchase in E.164 format. When provided, all other sea

data/lib/surge_api/resources/toll_free_campaigns.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Resources
+    class TollFreeCampaigns
+      # Creates a toll-free campaign and submits it for Surge review.
+      #
+      # @overload create(account_id, consent_flows:, description:, message_samples:, phone_number_id:, privacy_policy_url:, terms_and_conditions_url:, use_cases:, includes: nil, request_options: {})
+      #
+      # @param account_id [String] The account for which the toll-free campaign should be created.
+      #
+      # @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember3>]
+      #
+      # @param description [String] An explanation of how the toll-free number will be used.
+      #
+      # @param message_samples [Array<String>]
+      #
+      # @param phone_number_id [String] The toll-free phone number to register.
+      #
+      # @param privacy_policy_url [String]
+      #
+      # @param terms_and_conditions_url [String]
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaignParams::UseCase>]
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaignParams::Include>]
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignCreateParams
+      def create(account_id, params)
+        parsed, options = SurgeAPI::TollFreeCampaignCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["accounts/%1$s/toll_free_campaigns", account_id],
+          body: parsed,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # Retrieves a toll-free campaign object.
+      #
+      # @overload retrieve(campaign_id, request_options: {})
+      #
+      # @param campaign_id [String] The ID of the toll-free campaign to retrieve.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignRetrieveParams
+      def retrieve(campaign_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["toll_free_campaigns/%1$s", campaign_id],
+          model: SurgeAPI::TollFreeCampaign,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates a toll-free campaign awaiting customer fixes and re-submits it for Surge
+      # review. Returns 409 if the campaign is not in an updatable status.
+      #
+      # @overload update(campaign_id, consent_flows: nil, description: nil, includes: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil, request_options: {})
+      #
+      # @param campaign_id [String] The toll-free campaign ID to update.
+      #
+      # @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3>]
+      #
+      # @param description [String] An explanation of how the toll-free number will be used.
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::Include>]
+      #
+      # @param message_samples [Array<String>]
+      #
+      # @param privacy_policy_url [String]
+      #
+      # @param terms_and_conditions_url [String]
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::UseCase>]
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignUpdateParams
+      def update(campaign_id, params = {})
+        parsed, options = SurgeAPI::TollFreeCampaignUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["toll_free_campaigns/%1$s", campaign_id],
+          body: parsed,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::TollFreeCampaignListParams} for more details.
+      #
+      # List all toll-free campaigns for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list toll-free campaigns for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::TollFreeCampaign>]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::TollFreeCampaignListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/toll_free_campaigns", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/surge_api/resources/users.rb

@@ -138,15 +138,20 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::UserCreateTokenParams} for more details.
+      #
       # Provides a mechanism for having Surge create a signed token for embeds instead
       # of signing with your own signing key.
       #
-      # @overload create_token(user_id, duration_seconds: nil, request_options: {})
+      # @overload create_token(user_id, duration_seconds: nil, read_only: nil, request_options: {})
       #
       # @param user_id [String] The user for which the token represents authentication.
       #
       # @param duration_seconds [Integer] For how many seconds the token should be accepted. Defaults to 15 minutes.
       #
+      # @param read_only [Boolean] Restrict the token to viewing embedded conversations and unread counts. Sending
+      #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [SurgeAPI::Models::UserTokenResponse]

data/lib/surge_api/resources/webhooks.rb

@@ -9,7 +9,7 @@ module SurgeAPI
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
+      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::CampaignRejectedWebhookEvent, SurgeAPI::Models::CampaignSubmittedWebhookEvent, SurgeAPI::Models::CampaignWarningWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
       def unwrap(payload, headers:, key: @client.webhook_signing_secret)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_signing_secret or passed in as an argument")

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.23.0"
+  VERSION = "0.25.0"
 end

data/lib/surge_api.rb

@@ -56,6 +56,7 @@ require_relative "surge_api/client"
 require_relative "surge_api/internal/cursor"
 require_relative "surge_api/models/campaign_params"
 require_relative "surge_api/models/message_params"
+require_relative "surge_api/models/toll_free_campaign_params"
 require_relative "surge_api/models/account"
 require_relative "surge_api/models/account_archive_params"
 require_relative "surge_api/models/account_create_params"
@@ -77,10 +78,13 @@ require_relative "surge_api/models/campaign"
 require_relative "surge_api/models/campaign_approved_webhook_event"
 require_relative "surge_api/models/campaign_create_params"
 require_relative "surge_api/models/campaign_list_params"
+require_relative "surge_api/models/campaign_rejected_webhook_event"
 require_relative "surge_api/models/campaign_resend_brand_verification_message_params"
 require_relative "surge_api/models/campaign_resend_brand_verification_message_response"
 require_relative "surge_api/models/campaign_retrieve_params"
+require_relative "surge_api/models/campaign_submitted_webhook_event"
 require_relative "surge_api/models/campaign_update_params"
+require_relative "surge_api/models/campaign_warning_webhook_event"
 require_relative "surge_api/models/contact"
 require_relative "surge_api/models/contact_create_params"
 require_relative "surge_api/models/contact_list_params"
@@ -102,6 +106,7 @@ require_relative "surge_api/models/message_sent_webhook_event"
 require_relative "surge_api/models/organization"
 require_relative "surge_api/models/phone_number"
 require_relative "surge_api/models/phone_number_attached_to_campaign_webhook_event"
+require_relative "surge_api/models/phone_number_imported_webhook_event"
 require_relative "surge_api/models/phone_number_list_available_numbers_params"
 require_relative "surge_api/models/phone_number_list_available_numbers_response"
 require_relative "surge_api/models/phone_number_list_params"
@@ -118,6 +123,12 @@ require_relative "surge_api/models/recording_list_params"
 require_relative "surge_api/models/recording_list_response"
 require_relative "surge_api/models/recording_retrieve_params"
 require_relative "surge_api/models/recording_retrieve_response"
+require_relative "surge_api/models/toll_free_campaign"
+require_relative "surge_api/models/toll_free_campaign_consent_flow"
+require_relative "surge_api/models/toll_free_campaign_create_params"
+require_relative "surge_api/models/toll_free_campaign_list_params"
+require_relative "surge_api/models/toll_free_campaign_retrieve_params"
+require_relative "surge_api/models/toll_free_campaign_update_params"
 require_relative "surge_api/models/unwrap_webhook_event"
 require_relative "surge_api/models/user"
 require_relative "surge_api/models/user_create_params"
@@ -143,6 +154,7 @@ require_relative "surge_api/resources/contacts"
 require_relative "surge_api/resources/messages"
 require_relative "surge_api/resources/phone_numbers"
 require_relative "surge_api/resources/recordings"
+require_relative "surge_api/resources/toll_free_campaigns"
 require_relative "surge_api/resources/users"
 require_relative "surge_api/resources/verifications"
 require_relative "surge_api/resources/webhooks"

data/rbi/surge_api/client.rbi

@@ -43,6 +43,9 @@ module SurgeAPI
     sig { returns(SurgeAPI::Resources::Recordings) }
     attr_reader :recordings
 
+    sig { returns(SurgeAPI::Resources::TollFreeCampaigns) }
+    attr_reader :toll_free_campaigns
+
     sig { returns(SurgeAPI::Resources::Users) }
     attr_reader :users
 

data/rbi/surge_api/models/account_retrieve_status_params.rbi

@@ -88,6 +88,11 @@ module SurgeAPI
             :local_messaging,
             SurgeAPI::AccountRetrieveStatusParams::Capability::TaggedSymbol
           )
+        TOLL_FREE_MESSAGING =
+          T.let(
+            :toll_free_messaging,
+            SurgeAPI::AccountRetrieveStatusParams::Capability::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/surge_api/models/call_ended_webhook_event.rbi

@@ -88,7 +88,8 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :initiated_at
 
-        # 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.
         sig do
           returns(SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol)
         end
@@ -128,7 +129,8 @@ module SurgeAPI
           duration:,
           # When the call was initiated
           initiated_at:,
-          # 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.
           status:,
           # The E.164 phone number of the caller
           from: nil,
@@ -157,7 +159,8 @@ module SurgeAPI
         def to_hash
         end
 
-        # 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.
         module Status
           extend SurgeAPI::Internal::Type::Enum
 

data/rbi/surge_api/models/campaign.rbi

@@ -10,6 +10,10 @@ module SurgeAPI
       sig { returns(String) }
       attr_accessor :id
 
+      # The ID of the account that owns this campaign
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # 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
       # screenshots that might be helpful in explaining the flow to someone unfamiliar
@@ -86,21 +90,20 @@ 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.
       sig { returns(SurgeAPI::Campaign::Volume::TaggedSymbol) }
       attr_accessor :volume
 
-      # A sample link that might be sent by this campaign. If links from other domains
-      # are sent through this campaign, they are much more likely to be filtered by the
-      # carriers. If link shortening is enabled for the account, the link shortener URL
-      # will be used instead of what is provided. Reach out to support if you would like
-      # to disable automatic link shortening.
+      # A sample link that might be sent by this campaign. This is required when
+      # `includes` contains `links`. Provide the same URL or domain that the campaign
+      # will use in production. If links from other domains are sent through this
+      # campaign, they are much more likely to be filtered by the carriers.
       sig { returns(T.nilable(String)) }
       attr_reader :link_sample
 
@@ -122,6 +125,7 @@ module SurgeAPI
       sig do
         params(
           id: String,
+          account_id: String,
           consent_flow: String,
           description: String,
           includes: T::Array[SurgeAPI::Campaign::Include::OrSymbol],
@@ -137,6 +141,8 @@ module SurgeAPI
       def self.new(
         # The campaign ID
         id:,
+        # The ID of the account that owns this campaign
+        account_id:,
         # 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
         # screenshots that might be helpful in explaining the flow to someone unfamiliar
@@ -199,19 +205,18 @@ 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.
         volume:,
-        # A sample link that might be sent by this campaign. If links from other domains
-        # are sent through this campaign, they are much more likely to be filtered by the
-        # carriers. If link shortening is enabled for the account, the link shortener URL
-        # will be used instead of what is provided. Reach out to support if you would like
-        # to disable automatic link shortening.
+        # A sample link that might be sent by this campaign. This is required when
+        # `includes` contains `links`. Provide the same URL or domain that the campaign
+        # will use in production. If links from other domains are sent through this
+        # campaign, they are much more likely to be filtered by the carriers.
         link_sample: nil,
         # The URL of the terms and conditions presented to end users when they opt in to
         # messaging. These terms and conditions may be shared among all of a platform's
@@ -225,6 +230,7 @@ module SurgeAPI
         override.returns(
           {
             id: String,
+            account_id: String,
             consent_flow: String,
             description: String,
             includes: T::Array[SurgeAPI::Campaign::Include::TaggedSymbol],
@@ -272,6 +278,7 @@ module SurgeAPI
 
         ACTIVE = T.let(:active, SurgeAPI::Campaign::Status::TaggedSymbol)
         CANCELED = T.let(:canceled, SurgeAPI::Campaign::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, SurgeAPI::Campaign::Status::TaggedSymbol)
         CREATED = T.let(:created, SurgeAPI::Campaign::Status::TaggedSymbol)
         DEACTIVATED =
           T.let(:deactivated, SurgeAPI::Campaign::Status::TaggedSymbol)
@@ -333,11 +340,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.
       module Volume

data/rbi/surge_api/models/campaign_approved_webhook_event.rbi

@@ -78,6 +78,10 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :id
 
+        # The ID of the account that owns this campaign
+        sig { returns(String) }
+        attr_accessor :account_id
+
         # The status of the campaign. Will always be `active` for this event.
         sig do
           returns(
@@ -90,6 +94,7 @@ module SurgeAPI
         sig do
           params(
             id: String,
+            account_id: String,
             status:
               SurgeAPI::CampaignApprovedWebhookEvent::Data::Status::OrSymbol
           ).returns(T.attached_class)
@@ -97,6 +102,8 @@ module SurgeAPI
         def self.new(
           # The unique identifier for the campaign
           id:,
+          # The ID of the account that owns this campaign
+          account_id:,
           # The status of the campaign. Will always be `active` for this event.
           status:
         )
@@ -106,6 +113,7 @@ module SurgeAPI
           override.returns(
             {
               id: String,
+              account_id: String,
               status:
                 SurgeAPI::CampaignApprovedWebhookEvent::Data::Status::TaggedSymbol
             }