surge_api 0.24.0 → 0.25.0

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"
@@ -119,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"
@@ -144,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/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,11 +90,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.
       sig { returns(SurgeAPI::Campaign::Volume::TaggedSymbol) }
@@ -121,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],
@@ -136,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
@@ -198,11 +205,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.
         volume:,
@@ -223,6 +230,7 @@ module SurgeAPI
         override.returns(
           {
             id: String,
+            account_id: String,
             consent_flow: String,
             description: String,
             includes: T::Array[SurgeAPI::Campaign::Include::TaggedSymbol],
@@ -332,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
             }

data/rbi/surge_api/models/campaign_params.rbi

@@ -97,11 +97,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.
         sig do
@@ -228,11 +228,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.
           volume:,
@@ -356,11 +356,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_rejected_webhook_event.rbi

@@ -0,0 +1,269 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CampaignRejectedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::CampaignRejectedWebhookEvent,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the account in which this event occurred
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The data associated with the event
+      sig { returns(SurgeAPI::CampaignRejectedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: SurgeAPI::CampaignRejectedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `campaign.rejected` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::CampaignRejectedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account in which this event occurred
+        account_id:,
+        # The data associated with the event
+        data:,
+        # The timestamp when this event occurred, in ISO8601 format
+        timestamp:,
+        # The type of the event. Always `campaign.rejected` for this event.
+        type: :"campaign.rejected"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::CampaignRejectedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::CampaignRejectedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the campaign
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Customer-visible field-level registration feedback. Rejection events may include
+        # non-blocking warnings alongside changes-needed items.
+        sig do
+          returns(
+            T::Array[SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback]
+          )
+        end
+        attr_accessor :feedback
+
+        # The public campaign status. Always `rejected` for this event.
+        sig do
+          returns(
+            SurgeAPI::CampaignRejectedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            feedback:
+              T::Array[
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::OrHash
+              ],
+            status:
+              SurgeAPI::CampaignRejectedWebhookEvent::Data::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the campaign
+          id:,
+          # Customer-visible field-level registration feedback. Rejection events may include
+          # non-blocking warnings alongside changes-needed items.
+          feedback:,
+          # The public campaign status. Always `rejected` for this event.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              feedback:
+                T::Array[
+                  SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback
+                ],
+              status:
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Feedback < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The stable registration field key
+          sig { returns(String) }
+          attr_accessor :field
+
+          # Actionable review feedback
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Whether the feedback blocks registration or is a non-blocking warning
+          sig do
+            returns(
+              SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::TaggedSymbol
+            )
+          end
+          attr_accessor :outcome
+
+          # A suggested replacement value, or null when none is suggested
+          sig { returns(T.nilable(String)) }
+          attr_accessor :suggested_value
+
+          sig do
+            params(
+              field: String,
+              message: String,
+              outcome:
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::OrSymbol,
+              suggested_value: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The stable registration field key
+            field:,
+            # Actionable review feedback
+            message:,
+            # Whether the feedback blocks registration or is a non-blocking warning
+            outcome:,
+            # A suggested replacement value, or null when none is suggested
+            suggested_value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                field: String,
+                message: String,
+                outcome:
+                  SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::TaggedSymbol,
+                suggested_value: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Whether the feedback blocks registration or is a non-blocking warning
+          module Outcome
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHANGES_NEEDED =
+              T.let(
+                :changes_needed,
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::TaggedSymbol
+              )
+            WARNING =
+              T.let(
+                :warning,
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::CampaignRejectedWebhookEvent::Data::Feedback::Outcome::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # The public campaign status. Always `rejected` for this event.
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REJECTED =
+            T.let(
+              :rejected,
+              SurgeAPI::CampaignRejectedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::CampaignRejectedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/campaign_submitted_webhook_event.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CampaignSubmittedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::CampaignSubmittedWebhookEvent,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the account in which this event occurred
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The data associated with the event
+      sig { returns(SurgeAPI::CampaignSubmittedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: SurgeAPI::CampaignSubmittedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `campaign.submitted` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::CampaignSubmittedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account in which this event occurred
+        account_id:,
+        # The data associated with the event
+        data:,
+        # The timestamp when this event occurred, in ISO8601 format
+        timestamp:,
+        # The type of the event. Always `campaign.submitted` for this event.
+        type: :"campaign.submitted"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::CampaignSubmittedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::CampaignSubmittedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the campaign
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The public campaign status. Always `in_review` for this event.
+        sig do
+          returns(
+            SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            status:
+              SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the campaign
+          id:,
+          # The public campaign status. Always `in_review` for this event.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The public campaign status. Always `in_review` for this event.
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_REVIEW =
+            T.let(
+              :in_review,
+              SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::CampaignSubmittedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end