surge_api 0.17.0 → 0.19.0

data/rbi/surge_api/models/message_params.rbi

@@ -85,6 +85,24 @@ module SurgeAPI
         sig { params(send_at: Time).void }
         attr_writer :send_at
 
+        # Per-message setting overrides.
+        sig do
+          returns(
+            T.nilable(
+              SurgeAPI::MessageParams::MessageParamsWithConversation::Settings
+            )
+          )
+        end
+        attr_reader :settings
+
+        sig do
+          params(
+            settings:
+              SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::OrHash
+          ).void
+        end
+        attr_writer :settings
+
         # Create a message while including parameters for the conversation in which the
         # message should be sent.
         sig do
@@ -97,7 +115,9 @@ module SurgeAPI
               ],
             body: String,
             metadata: T::Hash[Symbol, String],
-            send_at: Time
+            send_at: Time,
+            settings:
+              SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -111,7 +131,9 @@ module SurgeAPI
           metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
-          send_at: nil
+          send_at: nil,
+          # Per-message setting overrides.
+          settings: nil
         )
         end
 
@@ -126,7 +148,9 @@ module SurgeAPI
                 ],
               body: String,
               metadata: T::Hash[Symbol, String],
-              send_at: Time
+              send_at: Time,
+              settings:
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings
             }
           )
         end
@@ -302,6 +326,93 @@ module SurgeAPI
           def to_hash
           end
         end
+
+        class Settings < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # Override link shortening for this message.
+          sig do
+            returns(
+              T.nilable(
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::OrSymbol
+              )
+            )
+          end
+          attr_reader :link_shortening
+
+          sig do
+            params(
+              link_shortening:
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::OrSymbol
+            ).void
+          end
+          attr_writer :link_shortening
+
+          # Per-message setting overrides.
+          sig do
+            params(
+              link_shortening:
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Override link shortening for this message.
+            link_shortening: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                link_shortening:
+                  SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Override link shortening for this message.
+          module LinkShortening
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENABLED =
+              T.let(
+                :enabled,
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::TaggedSymbol
+              )
+            DISABLED =
+              T.let(
+                :disabled,
+                SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       class SimpleMessageParams < SurgeAPI::Internal::Type::BaseModel
@@ -367,6 +478,22 @@ module SurgeAPI
         sig { params(send_at: Time).void }
         attr_writer :send_at
 
+        # Per-message setting overrides.
+        sig do
+          returns(
+            T.nilable(SurgeAPI::MessageParams::SimpleMessageParams::Settings)
+          )
+        end
+        attr_reader :settings
+
+        sig do
+          params(
+            settings:
+              SurgeAPI::MessageParams::SimpleMessageParams::Settings::OrHash
+          ).void
+        end
+        attr_writer :settings
+
         # Create a basic message by specifying just the to/from phone numbers.
         sig do
           params(
@@ -378,7 +505,9 @@ module SurgeAPI
             body: String,
             from: String,
             metadata: T::Hash[Symbol, String],
-            send_at: Time
+            send_at: Time,
+            settings:
+              SurgeAPI::MessageParams::SimpleMessageParams::Settings::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -395,7 +524,9 @@ module SurgeAPI
           metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
-          send_at: nil
+          send_at: nil,
+          # Per-message setting overrides.
+          settings: nil
         )
         end
 
@@ -410,7 +541,8 @@ module SurgeAPI
               body: String,
               from: String,
               metadata: T::Hash[Symbol, String],
-              send_at: Time
+              send_at: Time,
+              settings: SurgeAPI::MessageParams::SimpleMessageParams::Settings
             }
           )
         end
@@ -442,6 +574,93 @@ module SurgeAPI
           def to_hash
           end
         end
+
+        class Settings < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # Override link shortening for this message.
+          sig do
+            returns(
+              T.nilable(
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::OrSymbol
+              )
+            )
+          end
+          attr_reader :link_shortening
+
+          sig do
+            params(
+              link_shortening:
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::OrSymbol
+            ).void
+          end
+          attr_writer :link_shortening
+
+          # Per-message setting overrides.
+          sig do
+            params(
+              link_shortening:
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Override link shortening for this message.
+            link_shortening: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                link_shortening:
+                  SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Override link shortening for this message.
+          module LinkShortening
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENABLED =
+              T.let(
+                :enabled,
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::TaggedSymbol
+              )
+            DISABLED =
+              T.let(
+                :disabled,
+                SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       sig { override.returns(T::Array[SurgeAPI::MessageParams::Variants]) }

data/rbi/surge_api/models/message_received_webhook_event.rbi

@@ -329,6 +329,11 @@ module SurgeAPI
                 :link,
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::Type::TaggedSymbol
               )
+            CONTACT =
+              T.let(
+                :contact,
+                SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
             VIDEO =
               T.let(
                 :video,

data/rbi/surge_api/models/message_retrieve_params.rbi

@@ -11,15 +11,28 @@ module SurgeAPI
           T.any(SurgeAPI::MessageRetrieveParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the message to retrieve.
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The ID of the message to retrieve.
+        id:,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      sig do
+        override.returns(
+          { id: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/surge_api/models/message_sent_webhook_event.rbi

@@ -320,6 +320,11 @@ module SurgeAPI
                 :link,
                 SurgeAPI::MessageSentWebhookEvent::Data::Attachment::Type::TaggedSymbol
               )
+            CONTACT =
+              T.let(
+                :contact,
+                SurgeAPI::MessageSentWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
             VIDEO =
               T.let(
                 :video,

data/rbi/surge_api/models/phone_number_list_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::PhoneNumberListParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account ID to list phone numbers for.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # Cursor for forward pagination. Use the next_cursor from a previous response.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -28,12 +32,15 @@ module SurgeAPI
 
       sig do
         params(
+          account_id: String,
           after: String,
           before: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account ID to list phone numbers for.
+        account_id:,
         # Cursor for forward pagination. Use the next_cursor from a previous response.
         after: nil,
         # Cursor for backward pagination. Use the previous_cursor from a previous
@@ -46,6 +53,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            account_id: String,
             after: String,
             before: String,
             request_options: SurgeAPI::RequestOptions

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -14,6 +14,10 @@ module SurgeAPI
           )
         end
 
+      # The account for which the phone number should be created.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The desired area code for this phone number. If provided without type, the type
       # will be inferred.
       sig { returns(T.nilable(String)) }
@@ -60,6 +64,7 @@ module SurgeAPI
 
       sig do
         params(
+          account_id: String,
           area_code: String,
           latitude: Float,
           longitude: Float,
@@ -69,6 +74,8 @@ module SurgeAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account for which the phone number should be created.
+        account_id:,
         # The desired area code for this phone number. If provided without type, the type
         # will be inferred.
         area_code: nil,
@@ -91,6 +98,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            account_id: String,
             area_code: String,
             latitude: Float,
             longitude: Float,

data/rbi/surge_api/models/phone_number_release_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberReleaseParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::PhoneNumberReleaseParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The ID of the phone number to release.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the phone number to release.
+        id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/phone_number_update_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::PhoneNumberUpdateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The ID of the phone number to update.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Campaign ID to attach this number to (`cpn_...`).
+      sig { returns(T.nilable(String)) }
+      attr_reader :campaign_id
+
+      sig { params(campaign_id: String).void }
+      attr_writer :campaign_id
+
+      # A human-readable name for the phone number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig do
+        params(
+          id: String,
+          campaign_id: String,
+          name: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the phone number to update.
+        id:,
+        # Campaign ID to attach this number to (`cpn_...`).
+        campaign_id: nil,
+        # A human-readable name for the phone number.
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            campaign_id: String,
+            name: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/recording_completed_webhook_event.rbi

@@ -161,6 +161,18 @@ module SurgeAPI
           end
           attr_accessor :status
 
+          # The E.164 phone number of the caller
+          sig { returns(T.nilable(String)) }
+          attr_accessor :from
+
+          # The Surge phone number ID (e.g. pn\_...)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :phone_number_id
+
+          # The E.164 phone number of the callee
+          sig { returns(T.nilable(String)) }
+          attr_accessor :to
+
           # The call that produced this recording
           sig do
             params(
@@ -169,7 +181,10 @@ module SurgeAPI
               duration: Integer,
               initiated_at: Time,
               status:
-                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::OrSymbol
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::OrSymbol,
+              from: T.nilable(String),
+              phone_number_id: T.nilable(String),
+              to: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -182,7 +197,13 @@ module SurgeAPI
             # When the call was initiated
             initiated_at:,
             # The status of the call
-            status:
+            status:,
+            # The E.164 phone number of the caller
+            from: nil,
+            # The Surge phone number ID (e.g. pn\_...)
+            phone_number_id: nil,
+            # The E.164 phone number of the callee
+            to: nil
           )
           end
 
@@ -194,7 +215,10 @@ module SurgeAPI
                 duration: Integer,
                 initiated_at: Time,
                 status:
-                  SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+                  SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol,
+                from: T.nilable(String),
+                phone_number_id: T.nilable(String),
+                to: T.nilable(String)
               }
             )
           end

data/rbi/surge_api/models/recording_delete_params.rbi

@@ -11,15 +11,28 @@ module SurgeAPI
           T.any(SurgeAPI::RecordingDeleteParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the recording.
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The ID of the recording.
+        id:,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      sig do
+        override.returns(
+          { id: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/surge_api/models/recording_get_file_params.rbi

@@ -11,15 +11,28 @@ module SurgeAPI
           T.any(SurgeAPI::RecordingGetFileParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the recording.
+      sig { returns(String) }
+      attr_accessor :recording_id
+
       sig do
-        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          recording_id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The ID of the recording.
+        recording_id:,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      sig do
+        override.returns(
+          { recording_id: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/surge_api/models/recording_list_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::RecordingListParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account ID to list recordings for.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # Cursor for forward pagination. Use the next_cursor from a previous response.
       sig { returns(T.nilable(String)) }
       attr_reader :after
@@ -28,12 +32,15 @@ module SurgeAPI
 
       sig do
         params(
+          account_id: String,
           after: String,
           before: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account ID to list recordings for.
+        account_id:,
         # Cursor for forward pagination. Use the next_cursor from a previous response.
         after: nil,
         # Cursor for backward pagination. Use the previous_cursor from a previous
@@ -46,6 +53,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            account_id: String,
             after: String,
             before: String,
             request_options: SurgeAPI::RequestOptions