surge_api 0.14.0 → 0.16.0

data/rbi/surge_api/models/audience_create_params.rbi

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

data/rbi/surge_api/models/audience_create_response.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class AudienceCreateResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::AudienceCreateResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A name to identify this Audience. This name will only be visible within Surge.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # A group of contacts used for targeting messages.
+      sig { params(id: String, name: String).returns(T.attached_class) }
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # A name to identify this Audience. This name will only be visible within Surge.
+        name:
+      )
+      end
+
+      sig { override.returns({ id: String, name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/campaign_params.rbi

@@ -52,6 +52,13 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :privacy_policy_url
 
+        # The URL of the terms and conditions presented to end users when they opt in to
+        # messaging. These terms and conditions may be shared among all of a platform's
+        # customers if they're the terms that are presented to end users when they opt in
+        # to messaging.
+        sig { returns(String) }
+        attr_accessor :terms_and_conditions_url
+
         # A list containing 1-5 types of messages that will be sent with this campaign.
         #
         # The following use cases are typically available to all brands:
@@ -145,16 +152,6 @@ module SurgeAPI
         sig { params(link_sample: String).void }
         attr_writer :link_sample
 
-        # The URL of the terms and conditions presented to end users when they opt in to
-        # messaging. These terms and conditions may be shared among all of a platform's
-        # customers if they're the terms that are presented to end users when they opt in
-        # to messaging.
-        sig { returns(T.nilable(String)) }
-        attr_reader :terms_and_conditions_url
-
-        sig { params(terms_and_conditions_url: String).void }
-        attr_writer :terms_and_conditions_url
-
         # Full campaign details for standard registration through Surge
         sig do
           params(
@@ -162,6 +159,7 @@ module SurgeAPI
             description: String,
             message_samples: T::Array[String],
             privacy_policy_url: String,
+            terms_and_conditions_url: String,
             use_cases:
               T::Array[
                 SurgeAPI::CampaignParams::StandardCampaignParams::UseCase::OrSymbol
@@ -172,8 +170,7 @@ module SurgeAPI
               T::Array[
                 SurgeAPI::CampaignParams::StandardCampaignParams::Include::OrSymbol
               ],
-            link_sample: String,
-            terms_and_conditions_url: String
+            link_sample: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -197,6 +194,11 @@ module SurgeAPI
           # privacy policy if it's the policy that is displayed to end users when they opt
           # in to messaging.
           privacy_policy_url:,
+          # The URL of the terms and conditions presented to end users when they opt in to
+          # messaging. These terms and conditions may be shared among all of a platform's
+          # customers if they're the terms that are presented to end users when they opt in
+          # to messaging.
+          terms_and_conditions_url:,
           # A list containing 1-5 types of messages that will be sent with this campaign.
           #
           # The following use cases are typically available to all brands:
@@ -250,12 +252,7 @@ module SurgeAPI
           # carriers. If link shortening is enabled for the account, the link shortener URL
           # will be used instead of what is provided. Reach out to support if you would like
           # to disable automatic link shortening.
-          link_sample: nil,
-          # The URL of the terms and conditions presented to end users when they opt in to
-          # messaging. These terms and conditions may be shared among all of a platform's
-          # customers if they're the terms that are presented to end users when they opt in
-          # to messaging.
-          terms_and_conditions_url: nil
+          link_sample: nil
         )
         end
 
@@ -266,6 +263,7 @@ module SurgeAPI
               description: String,
               message_samples: T::Array[String],
               privacy_policy_url: String,
+              terms_and_conditions_url: String,
               use_cases:
                 T::Array[
                   SurgeAPI::CampaignParams::StandardCampaignParams::UseCase::OrSymbol
@@ -276,8 +274,7 @@ module SurgeAPI
                 T::Array[
                   SurgeAPI::CampaignParams::StandardCampaignParams::Include::OrSymbol
                 ],
-              link_sample: String,
-              terms_and_conditions_url: String
+              link_sample: String
             }
           )
         end

data/rbi/surge_api/models/campaign_update_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CampaignUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          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
+
+      sig do
+        params(
+          campaign_params:
+            T.any(
+              SurgeAPI::CampaignParams::StandardCampaignParams::OrHash,
+              SurgeAPI::CampaignParams::ExternalCampaignParams::OrHash
+            ),
+          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:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            campaign_params:
+              T.any(
+                SurgeAPI::CampaignParams::StandardCampaignParams,
+                SurgeAPI::CampaignParams::ExternalCampaignParams
+              ),
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/link_followed_webhook_event.rbi

@@ -75,8 +75,15 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :id
 
-        # The unique identifier for the message that contained the link
-        sig { returns(String) }
+        # A Message is a communication sent to a Contact.
+        sig { returns(T.nilable(SurgeAPI::Message)) }
+        attr_reader :message
+
+        sig { params(message: T.nilable(SurgeAPI::Message::OrHash)).void }
+        attr_writer :message
+
+        # Deprecated. The unique identifier for the message that contained the link.
+        sig { returns(T.nilable(String)) }
         attr_accessor :message_id
 
         # The original URL that was shortened
@@ -85,14 +92,19 @@ module SurgeAPI
 
         # The data associated with the event
         sig do
-          params(id: String, message_id: String, url: String).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            message: T.nilable(SurgeAPI::Message::OrHash),
+            message_id: T.nilable(String),
+            url: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the link
           id:,
-          # The unique identifier for the message that contained the link
+          # A Message is a communication sent to a Contact.
+          message:,
+          # Deprecated. The unique identifier for the message that contained the link.
           message_id:,
           # The original URL that was shortened
           url:
@@ -100,7 +112,14 @@ module SurgeAPI
         end
 
         sig do
-          override.returns({ id: String, message_id: String, url: String })
+          override.returns(
+            {
+              id: String,
+              message: T.nilable(SurgeAPI::Message),
+              message_id: T.nilable(String),
+              url: String
+            }
+          )
         end
         def to_hash
         end

data/rbi/surge_api/models/message.rbi

@@ -243,6 +243,10 @@ module SurgeAPI
           sig { returns(String) }
           attr_accessor :id
 
+          # A human-readable name for the phone number
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
           # The canonical format of the phone number.
           sig { returns(String) }
           attr_accessor :number
@@ -259,6 +263,7 @@ module SurgeAPI
           sig do
             params(
               id: String,
+              name: T.nilable(String),
               number: String,
               type: SurgeAPI::Message::Conversation::PhoneNumber::Type::OrSymbol
             ).returns(T.attached_class)
@@ -266,6 +271,8 @@ module SurgeAPI
           def self.new(
             # Unique identifier for the phone number
             id:,
+            # A human-readable name for the phone number
+            name:,
             # The canonical format of the phone number.
             number:,
             # Whether the phone number is local, toll-free, or short code
@@ -277,6 +284,7 @@ module SurgeAPI
             override.returns(
               {
                 id: String,
+                name: T.nilable(String),
                 number: String,
                 type:
                   SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol

data/rbi/surge_api/models/phone_number.rbi

@@ -16,6 +16,10 @@ module SurgeAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :campaign_id
 
+      # A human-readable name for the phone number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
       # The phone number in E.164 format
       sig { returns(String) }
       attr_accessor :number
@@ -29,6 +33,7 @@ module SurgeAPI
         params(
           id: String,
           campaign_id: T.nilable(String),
+          name: T.nilable(String),
           number: String,
           type: SurgeAPI::PhoneNumber::Type::OrSymbol
         ).returns(T.attached_class)
@@ -38,6 +43,8 @@ module SurgeAPI
         id:,
         # The unique identifier of the campaign this phone number is attached to, if any
         campaign_id:,
+        # A human-readable name for the phone number
+        name:,
         # The phone number in E.164 format
         number:,
         # Whether the phone number is local, toll-free, or short code
@@ -50,6 +57,7 @@ module SurgeAPI
           {
             id: String,
             campaign_id: T.nilable(String),
+            name: T.nilable(String),
             number: String,
             type: SurgeAPI::PhoneNumber::Type::TaggedSymbol
           }

data/rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi

@@ -88,6 +88,10 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :campaign_id
 
+        # A human-readable name for the phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
         # The phone number in E.164 format
         sig { returns(String) }
         attr_accessor :number
@@ -105,6 +109,7 @@ module SurgeAPI
           params(
             id: String,
             campaign_id: String,
+            name: T.nilable(String),
             number: String,
             type:
               SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::OrSymbol
@@ -115,6 +120,8 @@ module SurgeAPI
           id:,
           # The unique identifier of the campaign this phone number is attached to
           campaign_id:,
+          # A human-readable name for the phone number
+          name:,
           # The phone number in E.164 format
           number:,
           # Whether the phone number is local, toll-free, or short code
@@ -127,6 +134,7 @@ module SurgeAPI
             {
               id: String,
               campaign_id: String,
+              name: T.nilable(String),
               number: String,
               type:
                 SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -38,6 +38,14 @@ module SurgeAPI
       sig { params(longitude: Float).void }
       attr_writer :longitude
 
+      # A human-readable name for the phone number. If not provided, defaults to the
+      # formatted phone number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
       # Whether the phone number is local or toll-free. Can be omitted if area_code or
       # latitude/longitude are provided.
       sig do
@@ -55,6 +63,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          name: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -69,6 +78,9 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # A human-readable name for the phone number. If not provided, defaults to the
+        # formatted phone number.
+        name: nil,
         # Whether the phone number is local or toll-free. Can be omitted if area_code or
         # latitude/longitude are provided.
         type: nil,
@@ -82,6 +94,7 @@ module SurgeAPI
             area_code: String,
             latitude: Float,
             longitude: Float,
+            name: String,
             type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models.rbi

@@ -13,8 +13,12 @@ module SurgeAPI
 
   AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
 
+  AttachmentGetFileParams = SurgeAPI::Models::AttachmentGetFileParams
+
   AudienceAddContactParams = SurgeAPI::Models::AudienceAddContactParams
 
+  AudienceCreateParams = SurgeAPI::Models::AudienceCreateParams
+
   AudienceListContactsParams = SurgeAPI::Models::AudienceListContactsParams
 
   Blast = SurgeAPI::Models::Blast
@@ -35,6 +39,8 @@ module SurgeAPI
 
   CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
 
+  CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams

data/rbi/surge_api/resources/attachments.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Attachments
+      # Redirects to a signed URL where the attachment file can be downloaded. URL is
+      # short-lived, so redirect should be followed immediately.
+      sig do
+        params(
+          attachment_id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::AttachmentGetFileResponse)
+      end
+      def get_file(
+        # The ID of the attachment.
+        attachment_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/audiences.rbi

@@ -3,6 +3,23 @@
 module SurgeAPI
   module Resources
     class Audiences
+      # Creates a new audience.
+      sig do
+        params(
+          account_id: String,
+          name: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::AudienceCreateResponse)
+      end
+      def create(
+        # The account for which the audience should be created.
+        account_id,
+        # The audience name.
+        name:,
+        request_options: {}
+      )
+      end
+
       # Adds an existing contact to a manual audience.
       sig do
         params(

data/rbi/surge_api/resources/campaigns.rbi

@@ -35,6 +35,27 @@ module SurgeAPI
       )
       end
 
+      # Updates a campaign that has not yet been approved. This can be used to fix
+      # issues flagged during review and resubmit the campaign. Returns an error if the
+      # campaign is currently in review, has already been approved, or has been
+      # deactivated.
+      sig do
+        params(
+          id: String,
+          campaign_params: SurgeAPI::CampaignParams,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Campaign)
+      end
+      def update(
+        # The ID of the campaign to update.
+        id,
+        # Parameters for creating a new campaign. Either provide full campaign details or
+        # import using a TCR ID.
+        campaign_params:,
+        request_options: {}
+      )
+      end
+
       # List all campaigns for an account with cursor-based pagination.
       sig do
         params(

data/rbi/surge_api/resources/phone_numbers.rbi

@@ -32,6 +32,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          name: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::PhoneNumber)
@@ -48,6 +49,9 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # A human-readable name for the phone number. If not provided, defaults to the
+        # formatted phone number.
+        name: nil,
         # Whether the phone number is local or toll-free. Can be omitted if area_code or
         # latitude/longitude are provided.
         type: nil,

data/sig/surge_api/client.rbs

@@ -12,6 +12,8 @@ module SurgeAPI
 
     attr_reader accounts: SurgeAPI::Resources::Accounts
 
+    attr_reader attachments: SurgeAPI::Resources::Attachments
+
     attr_reader audiences: SurgeAPI::Resources::Audiences
 
     attr_reader blasts: SurgeAPI::Resources::Blasts

data/sig/surge_api/models/attachment_get_file_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type attachment_get_file_params =
+      {  } & 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
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models/attachment_get_file_response.rbs

@@ -0,0 +1,13 @@
+module SurgeAPI
+  module Models
+    type attachment_get_file_response = { error: SurgeAPI::Error }
+
+    class AttachmentGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor error: SurgeAPI::Error
+
+      def initialize: (error: SurgeAPI::Error) -> void
+
+      def to_hash: -> { error: SurgeAPI::Error }
+    end
+  end
+end

data/sig/surge_api/models/audience_create_params.rbs

@@ -0,0 +1,23 @@
+module SurgeAPI
+  module Models
+    type audience_create_params =
+      { 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 name: String
+
+      def initialize: (
+        name: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/audience_create_response.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type audience_create_response = { id: String, name: String }
+
+    class AudienceCreateResponse < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor name: String
+
+      def initialize: (id: String, name: String) -> void
+
+      def to_hash: -> { id: String, name: String }
+    end
+  end
+end