surge_api 0.17.0 → 0.18.0

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

data/sig/surge_api/models/audience_add_contact_params.rbs

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

data/sig/surge_api/models/audience_create_params.rbs

@@ -1,20 +1,25 @@
 module SurgeAPI
   module Models
     type audience_create_params =
-      { name: String } & SurgeAPI::Internal::Type::request_parameters
+      { account_id: String, name: String }
+      & SurgeAPI::Internal::Type::request_parameters
 
     class AudienceCreateParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_accessor name: String
 
       def initialize: (
+        account_id: String,
         name: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         name: String,
         request_options: SurgeAPI::RequestOptions
       }

data/sig/surge_api/models/audience_list_contacts_params.rbs

@@ -1,13 +1,15 @@
 module SurgeAPI
   module Models
     type audience_list_contacts_params =
-      { after: String, before: String }
+      { audience_id: String, after: String, before: String }
       & SurgeAPI::Internal::Type::request_parameters
 
     class AudienceListContactsParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor audience_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -17,12 +19,14 @@ module SurgeAPI
       def before=: (String) -> String
 
       def initialize: (
+        audience_id: String,
         ?after: String,
         ?before: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        audience_id: String,
         after: String,
         before: String,
         request_options: SurgeAPI::RequestOptions

data/sig/surge_api/models/blast_create_params.rbs

@@ -2,6 +2,7 @@ module SurgeAPI
   module Models
     type blast_create_params =
       {
+        account_id: String,
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         body: String?,
         contacts: ::Array[String],
@@ -17,6 +18,8 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_reader attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment]?
 
       def attachments=: (
@@ -50,6 +53,7 @@ module SurgeAPI
       def to=: (::Array[String]) -> ::Array[String]
 
       def initialize: (
+        account_id: String,
         ?attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         ?body: String?,
         ?contacts: ::Array[String],
@@ -62,6 +66,7 @@ module SurgeAPI
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         body: String?,
         contacts: ::Array[String],

data/sig/surge_api/models/campaign_create_params.rbs

@@ -1,26 +1,21 @@
 module SurgeAPI
   module Models
     type campaign_create_params =
-      { campaign_params: SurgeAPI::Models::campaign_params }
-      & SurgeAPI::Internal::Type::request_parameters
+      { account_id: String } & SurgeAPI::Internal::Type::request_parameters
 
     class CampaignCreateParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      def campaign_params: -> SurgeAPI::Models::campaign_params
-
-      def campaign_params=: (
-        SurgeAPI::Models::campaign_params _
-      ) -> SurgeAPI::Models::campaign_params
+      attr_accessor account_id: String
 
       def initialize: (
-        campaign_params: SurgeAPI::Models::campaign_params,
+        account_id: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
-        campaign_params: SurgeAPI::Models::campaign_params,
+        account_id: String,
         request_options: SurgeAPI::RequestOptions
       }
     end

data/sig/surge_api/models/campaign_list_params.rbs

@@ -1,13 +1,15 @@
 module SurgeAPI
   module Models
     type campaign_list_params =
-      { after: String, before: String }
+      { account_id: String, after: String, before: String }
       & SurgeAPI::Internal::Type::request_parameters
 
     class CampaignListParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -17,12 +19,14 @@ module SurgeAPI
       def before=: (String) -> String
 
       def initialize: (
+        account_id: String,
         ?after: String,
         ?before: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         after: String,
         before: String,
         request_options: SurgeAPI::RequestOptions

data/sig/surge_api/models/campaign_retrieve_params.rbs

@@ -1,15 +1,20 @@
 module SurgeAPI
   module Models
     type campaign_retrieve_params =
-      {  } & SurgeAPI::Internal::Type::request_parameters
+      { id: String } & SurgeAPI::Internal::Type::request_parameters
 
     class CampaignRetrieveParams < 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/campaign_update_params.rbs

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

data/sig/surge_api/models/contact_create_params.rbs

@@ -2,6 +2,7 @@ module SurgeAPI
   module Models
     type contact_create_params =
       {
+        account_id: String,
         phone_number: String,
         email: String,
         first_name: String,
@@ -14,6 +15,8 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_accessor phone_number: String
 
       attr_reader email: String?
@@ -33,6 +36,7 @@ module SurgeAPI
       def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
       def initialize: (
+        account_id: String,
         phone_number: String,
         ?email: String,
         ?first_name: String,
@@ -42,6 +46,7 @@ module SurgeAPI
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         phone_number: String,
         email: String,
         first_name: String,

data/sig/surge_api/models/contact_list_params.rbs

@@ -1,13 +1,15 @@
 module SurgeAPI
   module Models
     type contact_list_params =
-      { after: String, before: String }
+      { account_id: String, after: String, before: String }
       & SurgeAPI::Internal::Type::request_parameters
 
     class ContactListParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor account_id: String
+
       attr_reader after: String?
 
       def after=: (String) -> String
@@ -17,12 +19,14 @@ module SurgeAPI
       def before=: (String) -> String
 
       def initialize: (
+        account_id: String,
         ?after: String,
         ?before: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        account_id: String,
         after: String,
         before: String,
         request_options: SurgeAPI::RequestOptions

data/sig/surge_api/models/contact_retrieve_params.rbs

@@ -1,15 +1,20 @@
 module SurgeAPI
   module Models
     type contact_retrieve_params =
-      {  } & SurgeAPI::Internal::Type::request_parameters
+      { id: String } & SurgeAPI::Internal::Type::request_parameters
 
     class ContactRetrieveParams < 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/contact_update_params.rbs

@@ -2,6 +2,7 @@ module SurgeAPI
   module Models
     type contact_update_params =
       {
+        id: String,
         phone_number: String,
         email: String,
         first_name: String,
@@ -14,6 +15,8 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor phone_number: String
 
       attr_reader email: String?
@@ -33,6 +36,7 @@ module SurgeAPI
       def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
       def initialize: (
+        id: String,
         phone_number: String,
         ?email: String,
         ?first_name: String,
@@ -42,6 +46,7 @@ module SurgeAPI
       ) -> void
 
       def to_hash: -> {
+        id: String,
         phone_number: String,
         email: String,
         first_name: String,

data/sig/surge_api/models/message.rbs

@@ -87,7 +87,7 @@ module SurgeAPI
           url: String
         }
 
-        type type_ = :file | :image | :link | :video
+        type type_ = :file | :image | :link | :contact | :video
 
         module Type
           extend SurgeAPI::Internal::Type::Enum
@@ -95,6 +95,7 @@ module SurgeAPI
           FILE: :file
           IMAGE: :image
           LINK: :link
+          CONTACT: :contact
           VIDEO: :video
 
           def self?.values: -> ::Array[SurgeAPI::Models::Message::Attachment::type_]