surge_api 0.8.0 → 0.10.0

data/rbi/surge_api/resources/contacts.rbi

@@ -76,6 +76,27 @@ module SurgeAPI
       )
       end
 
+      # List all contacts for an account with cursor-based pagination.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Internal::Cursor[SurgeAPI::Contact])
+      end
+      def list(
+        # 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
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/surge_api/resources/messages.rbi

@@ -60,6 +60,27 @@ module SurgeAPI
       )
       end
 
+      # List all messages for an account with cursor-based pagination.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Internal::Cursor[SurgeAPI::Message])
+      end
+      def list(
+        # 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
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/surge_api/resources/phone_numbers.rbi

@@ -3,6 +3,27 @@
 module SurgeAPI
   module Resources
     class PhoneNumbers
+      # List all phone numbers for an account with cursor-based pagination.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Internal::Cursor[SurgeAPI::PhoneNumber])
+      end
+      def list(
+        # 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
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
       # Purchase a new phone number for the account. You can specify search criteria or
       # let the system select a random number.
       sig do

data/rbi/surge_api/resources/recordings.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Recordings
+      # Redirects to a signed URL where the recording audio file can be downloaded. URL
+      # is short-lived, so redirect should be followed immediately.
+      sig do
+        params(
+          recording_id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::RecordingGetFileResponse)
+      end
+      def get_file(
+        # The ID of the recording.
+        recording_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/webhooks.rbi

@@ -15,7 +15,9 @@ module SurgeAPI
             SurgeAPI::MessageDeliveredWebhookEvent,
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,
-            SurgeAPI::MessageSentWebhookEvent
+            SurgeAPI::MessageSentWebhookEvent,
+            SurgeAPI::RecordingCompletedWebhookEvent,
+            SurgeAPI::VoicemailReceivedWebhookEvent
           )
         )
       end

data/sig/surge_api/client.rbs

@@ -22,6 +22,8 @@ module SurgeAPI
 
     attr_reader phone_numbers: SurgeAPI::Resources::PhoneNumbers
 
+    attr_reader recordings: SurgeAPI::Resources::Recordings
+
     attr_reader users: SurgeAPI::Resources::Users
 
     attr_reader verifications: SurgeAPI::Resources::Verifications

data/sig/surge_api/internal/cursor.rbs

@@ -0,0 +1,28 @@
+module SurgeAPI
+  module Internal
+    class Cursor[Elem]
+      include SurgeAPI::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor pagination: Pagination
+
+      def inspect: -> String
+
+      type pagination = { next_cursor: String, previous_cursor: String }
+      class Pagination < SurgeAPI::Internal::Type::BaseModel
+        attr_reader next_cursor: String?
+
+        def next_cursor=: (String) -> String
+
+        attr_reader previous_cursor: String?
+
+        def previous_cursor=: (String) -> String
+
+        def initialize: (?next_cursor: String, ?previous_cursor: String) -> void
+
+        def to_hash: -> { next_cursor: String, previous_cursor: String }
+      end
+    end
+  end
+end

data/sig/surge_api/models/blast.rbs

@@ -4,7 +4,7 @@ module SurgeAPI
       {
         id: String,
         attachments: ::Array[SurgeAPI::Blast::Attachment],
-        body: String,
+        body: String?,
         name: String,
         send_at: Time
       }
@@ -20,9 +20,7 @@ module SurgeAPI
         ::Array[SurgeAPI::Blast::Attachment]
       ) -> ::Array[SurgeAPI::Blast::Attachment]
 
-      attr_reader body: String?
-
-      def body=: (String) -> String
+      attr_accessor body: String?
 
       attr_reader name: String?
 
@@ -35,7 +33,7 @@ module SurgeAPI
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Blast::Attachment],
-        ?body: String,
+        ?body: String?,
         ?name: String,
         ?send_at: Time
       ) -> void
@@ -43,7 +41,7 @@ module SurgeAPI
       def to_hash: -> {
         id: String,
         attachments: ::Array[SurgeAPI::Blast::Attachment],
-        body: String,
+        body: String?,
         name: String,
         send_at: Time
       }

data/sig/surge_api/models/blast_create_params.rbs

@@ -3,7 +3,7 @@ module SurgeAPI
     type blast_create_params =
       {
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
-        body: String,
+        body: String?,
         contacts: ::Array[String],
         from: String,
         name: String,
@@ -23,9 +23,7 @@ module SurgeAPI
         ::Array[SurgeAPI::BlastCreateParams::Attachment]
       ) -> ::Array[SurgeAPI::BlastCreateParams::Attachment]
 
-      attr_reader body: String?
-
-      def body=: (String) -> String
+      attr_accessor body: String?
 
       attr_reader contacts: ::Array[String]?
 
@@ -53,7 +51,7 @@ module SurgeAPI
 
       def initialize: (
         ?attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
-        ?body: String,
+        ?body: String?,
         ?contacts: ::Array[String],
         ?from: String,
         ?name: String,
@@ -65,7 +63,7 @@ module SurgeAPI
 
       def to_hash: -> {
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
-        body: String,
+        body: String?,
         contacts: ::Array[String],
         from: String,
         name: String,

data/sig/surge_api/models/campaign.rbs

@@ -8,6 +8,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         link_sample: String,
@@ -27,6 +28,8 @@ module SurgeAPI
 
       attr_accessor privacy_policy_url: String
 
+      attr_accessor status: SurgeAPI::Models::Campaign::status
+
       attr_accessor use_cases: ::Array[SurgeAPI::Models::Campaign::use_case]
 
       attr_accessor volume: SurgeAPI::Models::Campaign::volume
@@ -46,6 +49,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         ?link_sample: String,
@@ -59,6 +63,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         link_sample: String,
@@ -78,6 +83,29 @@ module SurgeAPI
         def self?.values: -> ::Array[SurgeAPI::Models::Campaign::include_]
       end
 
+      type status =
+        :active
+        | :canceled
+        | :created
+        | :deactivated
+        | :in_review
+        | :pending
+        | :rejected
+
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACTIVE: :active
+        CANCELED: :canceled
+        CREATED: :created
+        DEACTIVATED: :deactivated
+        IN_REVIEW: :in_review
+        PENDING: :pending
+        REJECTED: :rejected
+
+        def self?.values: -> ::Array[SurgeAPI::Models::Campaign::status]
+      end
+
       type use_case =
         :account_notification
         | :customer_care

data/sig/surge_api/models/campaign_retrieve_params.rbs

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

data/sig/surge_api/models/contact_list_params.rbs

@@ -0,0 +1,32 @@
+module SurgeAPI
+  module Models
+    type contact_list_params =
+      { 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_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/message.rbs

@@ -4,8 +4,8 @@ module SurgeAPI
       {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
-        blast_id: String,
-        body: String,
+        blast_id: String?,
+        body: String?,
         conversation: SurgeAPI::Message::Conversation,
         metadata: ::Hash[Symbol, String]
       }
@@ -21,13 +21,9 @@ module SurgeAPI
         ::Array[SurgeAPI::Message::Attachment]
       ) -> ::Array[SurgeAPI::Message::Attachment]
 
-      attr_reader blast_id: String?
+      attr_accessor blast_id: String?
 
-      def blast_id=: (String) -> String
-
-      attr_reader body: String?
-
-      def body=: (String) -> String
+      attr_accessor body: String?
 
       attr_reader conversation: SurgeAPI::Message::Conversation?
 
@@ -42,8 +38,8 @@ module SurgeAPI
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Message::Attachment],
-        ?blast_id: String,
-        ?body: String,
+        ?blast_id: String?,
+        ?body: String?,
         ?conversation: SurgeAPI::Message::Conversation,
         ?metadata: ::Hash[Symbol, String]
       ) -> void
@@ -51,8 +47,8 @@ module SurgeAPI
       def to_hash: -> {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
-        blast_id: String,
-        body: String,
+        blast_id: String?,
+        body: String?,
         conversation: SurgeAPI::Message::Conversation,
         metadata: ::Hash[Symbol, String]
       }

data/sig/surge_api/models/message_delivered_webhook_event.rbs

@@ -34,7 +34,7 @@ module SurgeAPI
       type data =
         {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
@@ -44,7 +44,7 @@ module SurgeAPI
       class Data < SurgeAPI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor body: String
+        attr_accessor body: String?
 
         attr_accessor conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation
 
@@ -62,7 +62,7 @@ module SurgeAPI
 
         def initialize: (
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           ?attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
@@ -71,7 +71,7 @@ module SurgeAPI
 
         def to_hash: -> {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],

data/sig/surge_api/models/message_failed_webhook_event.rbs

@@ -34,7 +34,7 @@ module SurgeAPI
       type data =
         {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,
@@ -45,7 +45,7 @@ module SurgeAPI
       class Data < SurgeAPI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor body: String
+        attr_accessor body: String?
 
         attr_accessor conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation
 
@@ -65,7 +65,7 @@ module SurgeAPI
 
         def initialize: (
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,
@@ -75,7 +75,7 @@ module SurgeAPI
 
         def to_hash: -> {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,

data/sig/surge_api/models/message_list_params.rbs

@@ -0,0 +1,32 @@
+module SurgeAPI
+  module Models
+    type message_list_params =
+      { after: String, before: String }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class MessageListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/message_received_webhook_event.rbs

@@ -34,7 +34,7 @@ module SurgeAPI
       type data =
         {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
@@ -44,7 +44,7 @@ module SurgeAPI
       class Data < SurgeAPI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor body: String
+        attr_accessor body: String?
 
         attr_accessor conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation
 
@@ -62,7 +62,7 @@ module SurgeAPI
 
         def initialize: (
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
           ?attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
@@ -71,7 +71,7 @@ module SurgeAPI
 
         def to_hash: -> {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],

data/sig/surge_api/models/message_sent_webhook_event.rbs

@@ -34,7 +34,7 @@ module SurgeAPI
       type data =
         {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
@@ -44,7 +44,7 @@ module SurgeAPI
       class Data < SurgeAPI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor body: String
+        attr_accessor body: String?
 
         attr_accessor conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation
 
@@ -62,7 +62,7 @@ module SurgeAPI
 
         def initialize: (
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
           ?attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
@@ -71,7 +71,7 @@ module SurgeAPI
 
         def to_hash: -> {
           id: String,
-          body: String,
+          body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],

data/sig/surge_api/models/phone_number_list_params.rbs

@@ -0,0 +1,32 @@
+module SurgeAPI
+  module Models
+    type phone_number_list_params =
+      { after: String, before: String }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class PhoneNumberListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end