surge_api 0.17.0 → 0.18.0

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_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

data/rbi/surge_api/models/recording_retrieve_params.rbi

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

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::UserCreateParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account for which the user should be created.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The user's first name.
       sig { returns(String) }
       attr_accessor :first_name
@@ -38,6 +42,7 @@ module SurgeAPI
 
       sig do
         params(
+          account_id: String,
           first_name: String,
           last_name: String,
           metadata: T::Hash[Symbol, String],
@@ -46,6 +51,8 @@ module SurgeAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account for which the user should be created.
+        account_id:,
         # The user's first name.
         first_name:,
         # The user's last name.
@@ -61,6 +68,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            account_id: String,
             first_name: String,
             last_name: String,
             metadata: T::Hash[Symbol, String],

data/rbi/surge_api/models/user_create_token_params.rbi

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::UserCreateTokenParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The user for which the token represents authentication.
+      sig { returns(String) }
+      attr_accessor :user_id
+
       # For how many seconds the token should be accepted. Defaults to 15 minutes.
       sig { returns(T.nilable(Integer)) }
       attr_reader :duration_seconds
@@ -20,11 +24,14 @@ module SurgeAPI
 
       sig do
         params(
+          user_id: String,
           duration_seconds: Integer,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The user for which the token represents authentication.
+        user_id:,
         # For how many seconds the token should be accepted. Defaults to 15 minutes.
         duration_seconds: nil,
         request_options: {}
@@ -34,6 +41,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            user_id: String,
             duration_seconds: Integer,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models/user_delete_params.rbi

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

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

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

@@ -11,6 +11,10 @@ module SurgeAPI
           T.any(SurgeAPI::UserUpdateParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the user to update.
+      sig { returns(String) }
+      attr_accessor :id
+
       # The user's first name.
       sig { returns(String) }
       attr_accessor :first_name
@@ -38,6 +42,7 @@ module SurgeAPI
 
       sig do
         params(
+          id: String,
           first_name: String,
           last_name: String,
           metadata: T::Hash[Symbol, String],
@@ -46,6 +51,8 @@ module SurgeAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The ID of the user to update.
+        id:,
         # The user's first name.
         first_name:,
         # The user's last name.
@@ -61,6 +68,7 @@ module SurgeAPI
       sig do
         override.returns(
           {
+            id: String,
             first_name: String,
             last_name: String,
             metadata: T::Hash[Symbol, String],

data/rbi/surge_api/models/verification_check_params.rbi

@@ -11,17 +11,24 @@ module SurgeAPI
           T.any(SurgeAPI::VerificationCheckParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The ID of the verification to check against.
+      sig { returns(String) }
+      attr_accessor :id
+
       # The Verification code that was received.
       sig { returns(String) }
       attr_accessor :code
 
       sig do
         params(
+          id: String,
           code: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The ID of the verification to check against.
+        id:,
         # The Verification code that was received.
         code:,
         request_options: {}
@@ -30,7 +37,11 @@ module SurgeAPI
 
       sig do
         override.returns(
-          { code: String, request_options: SurgeAPI::RequestOptions }
+          {
+            id: String,
+            code: String,
+            request_options: SurgeAPI::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/surge_api/models/verification_create_params.rbi

@@ -11,17 +11,24 @@ module SurgeAPI
           T.any(SurgeAPI::VerificationCreateParams, SurgeAPI::Internal::AnyHash)
         end
 
+      # The account to associate with the verification.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The phone number to be verified. In E.164 format.
       sig { returns(String) }
       attr_accessor :phone_number
 
       sig do
         params(
+          account_id: String,
           phone_number: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The account to associate with the verification.
+        account_id:,
         # The phone number to be verified. In E.164 format.
         phone_number:,
         request_options: {}
@@ -30,7 +37,11 @@ module SurgeAPI
 
       sig do
         override.returns(
-          { phone_number: String, request_options: SurgeAPI::RequestOptions }
+          {
+            account_id: String,
+            phone_number: String,
+            request_options: SurgeAPI::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/surge_api/models.rbi

@@ -93,6 +93,10 @@ module SurgeAPI
 
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
 
+  PhoneNumberReleaseParams = SurgeAPI::Models::PhoneNumberReleaseParams
+
+  PhoneNumberUpdateParams = SurgeAPI::Models::PhoneNumberUpdateParams
+
   RecordingCompletedWebhookEvent =
     SurgeAPI::Models::RecordingCompletedWebhookEvent