surge_api 0.17.0 → 0.18.0

data/rbi/surge_api/models/campaign_list_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::CampaignListParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account ID to list campaigns 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 campaigns 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/campaign_retrieve_params.rbi

@@ -11,15 +11,28 @@ module SurgeAPI
           T.any(SurgeAPI::CampaignRetrieveParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the campaign 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 campaign 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/campaign_update_params.rbi

@@ -11,46 +11,26 @@ module SurgeAPI
           T.any(SurgeAPI::CampaignUpdateParams, SurgeAPI::Internal::AnyHash)
         end
 
-      # Parameters for creating a new campaign. Either provide full campaign details or
-      # import using a TCR ID.
-      sig do
-        returns(
-          T.any(
-            SurgeAPI::CampaignParams::StandardCampaignParams,
-            SurgeAPI::CampaignParams::ExternalCampaignParams
-          )
-        )
-      end
-      attr_accessor :campaign_params
+      # The ID of the campaign to update.
+      sig { returns(String) }
+      attr_accessor :id
 
       sig do
         params(
-          campaign_params:
-            T.any(
-              SurgeAPI::CampaignParams::StandardCampaignParams::OrHash,
-              SurgeAPI::CampaignParams::ExternalCampaignParams::OrHash
-            ),
+          id: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Parameters for creating a new campaign. Either provide full campaign details or
-        # import using a TCR ID.
-        campaign_params:,
+        # The ID of the campaign to update.
+        id:,
         request_options: {}
       )
       end
 
       sig do
         override.returns(
-          {
-            campaign_params:
-              T.any(
-                SurgeAPI::CampaignParams::StandardCampaignParams,
-                SurgeAPI::CampaignParams::ExternalCampaignParams
-              ),
-            request_options: SurgeAPI::RequestOptions
-          }
+          { id: String, request_options: SurgeAPI::RequestOptions }
         )
       end
       def to_hash

data/rbi/surge_api/models/contact_create_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::ContactCreateParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account for which the contact should be created.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The contact's phone number in E.164 format.
       sig { returns(String) }
       attr_accessor :phone_number
@@ -45,6 +49,7 @@ module SurgeAPI
 
       sig do
         params(
+          account_id: String,
           phone_number: String,
           email: String,
           first_name: String,
@@ -54,6 +59,8 @@ module SurgeAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account for which the contact should be created.
+        account_id:,
         # The contact's phone number in E.164 format.
         phone_number:,
         # The contact's email address.
@@ -71,6 +78,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            account_id: String,
             phone_number: String,
             email: String,
             first_name: String,

data/rbi/surge_api/models/contact_list_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::ContactListParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account ID to list contacts 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 contacts 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/contact_retrieve_params.rbi

@@ -11,15 +11,28 @@ module SurgeAPI
           T.any(SurgeAPI::ContactRetrieveParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the contact 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 contact 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/contact_update_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::ContactUpdateParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the contact to update.
+      sig { returns(String) }
+      attr_accessor :id
+
       # The contact's phone number in E.164 format.
       sig { returns(String) }
       attr_accessor :phone_number
@@ -45,6 +49,7 @@ module SurgeAPI
 
       sig do
         params(
+          id: String,
           phone_number: String,
           email: String,
           first_name: String,
@@ -54,6 +59,8 @@ module SurgeAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The ID of the contact to update.
+        id:,
         # The contact's phone number in E.164 format.
         phone_number:,
         # The contact's email address.
@@ -71,6 +78,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            id: String,
             phone_number: String,
             email: String,
             first_name: String,

data/rbi/surge_api/models/message.rbi

@@ -159,6 +159,8 @@ module SurgeAPI
           IMAGE =
             T.let(:image, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
           LINK = T.let(:link, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          CONTACT =
+            T.let(:contact, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
           VIDEO =
             T.let(:video, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
 

data/rbi/surge_api/models/message_create_params.rbi

@@ -11,48 +11,26 @@ module SurgeAPI
           T.any(SurgeAPI::MessageCreateParams, SurgeAPI::Internal::AnyHash)
         end
 
-      # Payload for creating a message. Either an attachment or the body must be given.
-      # You can specify the recipient either using the 'conversation' parameter or the
-      # 'to'/'from' parameters, but not both.
-      sig do
-        returns(
-          T.any(
-            SurgeAPI::MessageParams::MessageParamsWithConversation,
-            SurgeAPI::MessageParams::SimpleMessageParams
-          )
-        )
-      end
-      attr_accessor :message_params
+      # The account from which the message should be sent.
+      sig { returns(String) }
+      attr_accessor :account_id
 
       sig do
         params(
-          message_params:
-            T.any(
-              SurgeAPI::MessageParams::MessageParamsWithConversation::OrHash,
-              SurgeAPI::MessageParams::SimpleMessageParams::OrHash
-            ),
+          account_id: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Payload for creating a message. Either an attachment or the body must be given.
-        # You can specify the recipient either using the 'conversation' parameter or the
-        # 'to'/'from' parameters, but not both.
-        message_params:,
+        # The account from which the message should be sent.
+        account_id:,
         request_options: {}
       )
       end
 
       sig do
         override.returns(
-          {
-            message_params:
-              T.any(
-                SurgeAPI::MessageParams::MessageParamsWithConversation,
-                SurgeAPI::MessageParams::SimpleMessageParams
-              ),
-            request_options: SurgeAPI::RequestOptions
-          }
+          { account_id: String, request_options: SurgeAPI::RequestOptions }
         )
       end
       def to_hash

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

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

data/rbi/surge_api/models/message_failed_webhook_event.rbi

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

data/rbi/surge_api/models/message_list_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::MessageListParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account ID to list messages 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 messages 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/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]) }