surge_api 0.17.0 → 0.19.0

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/voicemail_received_webhook_event.rbi

@@ -167,6 +167,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 resulted in this voicemail
           sig do
             params(
@@ -175,7 +187,10 @@ module SurgeAPI
               duration: Integer,
               initiated_at: Time,
               status:
-                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::OrSymbol
+                SurgeAPI::VoicemailReceivedWebhookEvent::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(
@@ -188,7 +203,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
 
@@ -200,7 +221,10 @@ module SurgeAPI
                 duration: Integer,
                 initiated_at: Time,
                 status:
-                  SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+                  SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol,
+                from: T.nilable(String),
+                phone_number_id: T.nilable(String),
+                to: T.nilable(String)
               }
             )
           end

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
 

data/rbi/surge_api/resources/campaigns.rbi

@@ -7,7 +7,11 @@ module SurgeAPI
       sig do
         params(
           account_id: String,
-          campaign_params: SurgeAPI::CampaignParams,
+          campaign_params:
+            T.any(
+              SurgeAPI::CampaignParams::StandardCampaignParams::OrHash,
+              SurgeAPI::CampaignParams::ExternalCampaignParams::OrHash
+            ),
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::Campaign)
       end
@@ -42,7 +46,11 @@ module SurgeAPI
       sig do
         params(
           id: String,
-          campaign_params: SurgeAPI::CampaignParams,
+          campaign_params:
+            T.any(
+              SurgeAPI::CampaignParams::StandardCampaignParams::OrHash,
+              SurgeAPI::CampaignParams::ExternalCampaignParams::OrHash
+            ),
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::Campaign)
       end

data/rbi/surge_api/resources/messages.rbi

@@ -28,10 +28,18 @@ module SurgeAPI
       # are provided. Similarly the `from` field cannot be used together with the
       # `conversation` field, and `conversation.phone_number` should be specified
       # instead.
+      #
+      # Optionally, you can pass a `settings` object to override account-level settings
+      # for this message. Currently the only supported setting is `link_shortening`,
+      # which accepts `"enabled"` or `"disabled"`.
       sig do
         params(
           account_id: String,
-          message_params: SurgeAPI::MessageParams,
+          message_params:
+            T.any(
+              SurgeAPI::MessageParams::MessageParamsWithConversation::OrHash,
+              SurgeAPI::MessageParams::SimpleMessageParams::OrHash
+            ),
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::Message)
       end

data/rbi/surge_api/resources/phone_numbers.rbi

@@ -3,6 +3,26 @@
 module SurgeAPI
   module Resources
     class PhoneNumbers
+      # Updates a phone number's details.
+      sig do
+        params(
+          id: String,
+          campaign_id: String,
+          name: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::PhoneNumber)
+      end
+      def update(
+        # 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
+
       # List all phone numbers for an account with cursor-based pagination.
       sig do
         params(
@@ -59,6 +79,20 @@ module SurgeAPI
       )
       end
 
+      # Releases a phone number from the account.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::PhoneNumber)
+      end
+      def release(
+        # The ID of the phone number to release.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/surge_api/resources/verifications.rbi

@@ -3,14 +3,18 @@
 module SurgeAPI
   module Resources
     class Verifications
-      # Creates a new Verification and sends the code to the given phone number.
+      # Creates a new Verification for an account and sends the code to the given phone
+      # number.
       sig do
         params(
+          account_id: String,
           phone_number: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::Verification)
       end
       def create(
+        # The account to associate with the verification.
+        account_id,
         # The phone number to be verified. In E.164 format.
         phone_number:,
         request_options: {}

data/rbi/surge_api/resources/webhooks.rbi

@@ -4,7 +4,11 @@ module SurgeAPI
   module Resources
     class Webhooks
       sig do
-        params(payload: String).returns(
+        params(
+          payload: String,
+          headers: T::Hash[String, String],
+          key: T.nilable(String)
+        ).returns(
           T.any(
             SurgeAPI::CallEndedWebhookEvent,
             SurgeAPI::CampaignApprovedWebhookEvent,
@@ -24,7 +28,11 @@ module SurgeAPI
       end
       def unwrap(
         # The raw webhook payload as a string
-        payload
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing key
+        key: @client.webhook_signing_secret
       )
       end
 

data/sig/surge_api/client.rbs

@@ -10,6 +10,8 @@ module SurgeAPI
 
     attr_reader api_key: String
 
+    attr_reader webhook_signing_secret: String?
+
     attr_reader accounts: SurgeAPI::Resources::Accounts
 
     attr_reader attachments: SurgeAPI::Resources::Attachments
@@ -38,6 +40,7 @@ module SurgeAPI
 
     def initialize: (
       ?api_key: String?,
+      ?webhook_signing_secret: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

data/sig/surge_api/internal/util.rbs

@@ -45,8 +45,12 @@ module SurgeAPI
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]

data/sig/surge_api/models/account_archive_params.rbs

@@ -1,15 +1,20 @@
 module SurgeAPI
   module Models
     type account_archive_params =
-      {  } & SurgeAPI::Internal::Type::request_parameters
+      { id: String } & SurgeAPI::Internal::Type::request_parameters
 
     class AccountArchiveParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+      attr_accessor id: String
 
-      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+      def initialize: (
+        id: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: SurgeAPI::RequestOptions }
     end
   end
 end

data/sig/surge_api/models/account_retrieve_status_params.rbs

@@ -2,6 +2,7 @@ module SurgeAPI
   module Models
     type account_retrieve_status_params =
       {
+        account_id: String,
         capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
       }
       & SurgeAPI::Internal::Type::request_parameters
@@ -10,6 +11,8 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_reader capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]?
 
       def capabilities=: (
@@ -17,11 +20,13 @@ module SurgeAPI
       ) -> ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
 
       def initialize: (
+        account_id: String,
         ?capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],
         request_options: SurgeAPI::RequestOptions
       }

data/sig/surge_api/models/account_update_params.rbs

@@ -2,6 +2,7 @@ module SurgeAPI
   module Models
     type account_update_params =
       {
+        id: String,
         brand_name: String,
         name: String,
         organization: SurgeAPI::AccountUpdateParams::Organization,
@@ -13,6 +14,8 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader brand_name: String?
 
       def brand_name=: (String) -> String
@@ -30,6 +33,7 @@ module SurgeAPI
       attr_accessor time_zone: String?
 
       def initialize: (
+        id: String,
         ?brand_name: String,
         ?name: String,
         ?organization: SurgeAPI::AccountUpdateParams::Organization,
@@ -38,6 +42,7 @@ module SurgeAPI
       ) -> void
 
       def to_hash: -> {
+        id: String,
         brand_name: String,
         name: String,
         organization: SurgeAPI::AccountUpdateParams::Organization,

data/sig/surge_api/models/attachment_get_file_params.rbs

@@ -1,15 +1,23 @@
 module SurgeAPI
   module Models
     type attachment_get_file_params =
-      {  } & SurgeAPI::Internal::Type::request_parameters
+      { attachment_id: String } & SurgeAPI::Internal::Type::request_parameters
 
     class AttachmentGetFileParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+      attr_accessor attachment_id: String
 
-      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+      def initialize: (
+        attachment_id: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        attachment_id: String,
+        request_options: SurgeAPI::RequestOptions
+      }
     end
   end
 end