surge_api 0.8.0 → 0.9.0

data/rbi/surge_api/internal/cursor.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module SurgeAPI
+  module Internal
+    class Cursor
+      include SurgeAPI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :data
+
+      sig { returns(Pagination) }
+      attr_accessor :pagination
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Pagination < SurgeAPI::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Pagination, SurgeAPI::Internal::AnyHash) }
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_cursor
+
+        sig { params(next_cursor: String).void }
+        attr_writer :next_cursor
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :previous_cursor
+
+        sig { params(previous_cursor: String).void }
+        attr_writer :previous_cursor
+
+        sig do
+          params(next_cursor: String, previous_cursor: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(next_cursor: nil, previous_cursor: nil)
+        end
+
+        sig do
+          override.returns({ next_cursor: String, previous_cursor: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/blast.rbi

@@ -23,10 +23,7 @@ module SurgeAPI
 
       # The message body.
       sig { returns(T.nilable(String)) }
-      attr_reader :body
-
-      sig { params(body: String).void }
-      attr_writer :body
+      attr_accessor :body
 
       # Optional name for the blast.
       sig { returns(T.nilable(String)) }
@@ -47,7 +44,7 @@ module SurgeAPI
         params(
           id: String,
           attachments: T::Array[SurgeAPI::Blast::Attachment::OrHash],
-          body: String,
+          body: T.nilable(String),
           name: String,
           send_at: Time
         ).returns(T.attached_class)
@@ -70,7 +67,7 @@ module SurgeAPI
           {
             id: String,
             attachments: T::Array[SurgeAPI::Blast::Attachment],
-            body: String,
+            body: T.nilable(String),
             name: String,
             send_at: Time
           }

data/rbi/surge_api/models/blast_create_params.rbi

@@ -25,10 +25,7 @@ module SurgeAPI
 
       # The message body.
       sig { returns(T.nilable(String)) }
-      attr_reader :body
-
-      sig { params(body: String).void }
-      attr_writer :body
+      attr_accessor :body
 
       # Deprecated. Use `to` instead.
       sig { returns(T.nilable(T::Array[String])) }
@@ -79,7 +76,7 @@ module SurgeAPI
         params(
           attachments:
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
-          body: String,
+          body: T.nilable(String),
           contacts: T::Array[String],
           from: String,
           name: String,
@@ -116,7 +113,7 @@ module SurgeAPI
         override.returns(
           {
             attachments: T::Array[SurgeAPI::BlastCreateParams::Attachment],
-            body: String,
+            body: T.nilable(String),
             contacts: T::Array[String],
             from: String,
             name: String,

data/rbi/surge_api/models/contact_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class ContactListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::ContactListParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Cursor for forward pagination. Use the next_cursor from a previous response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for backward pagination. Use the previous_cursor from a previous
+      # response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/message.rbi

@@ -33,10 +33,7 @@ module SurgeAPI
 
       # The message body.
       sig { returns(T.nilable(String)) }
-      attr_reader :body
-
-      sig { params(body: String).void }
-      attr_writer :body
+      attr_accessor :body
 
       # A conversation with a Contact
       sig { returns(T.nilable(SurgeAPI::Message::Conversation)) }
@@ -58,7 +55,7 @@ module SurgeAPI
           id: String,
           attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
           blast_id: String,
-          body: String,
+          body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
           metadata: T::Hash[Symbol, String]
         ).returns(T.attached_class)
@@ -85,7 +82,7 @@ module SurgeAPI
             id: String,
             attachments: T::Array[SurgeAPI::Message::Attachment],
             blast_id: String,
-            body: String,
+            body: T.nilable(String),
             conversation: SurgeAPI::Message::Conversation,
             metadata: T::Hash[Symbol, String]
           }

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -79,7 +79,7 @@ module SurgeAPI
         attr_accessor :id
 
         # The content of the message
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :body
 
         # The conversation this message belongs to
@@ -132,7 +132,7 @@ module SurgeAPI
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
@@ -164,7 +164,7 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,

data/rbi/surge_api/models/message_failed_webhook_event.rbi

@@ -79,7 +79,7 @@ module SurgeAPI
         attr_accessor :id
 
         # The content of the message
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :body
 
         # The conversation this message belongs to
@@ -134,7 +134,7 @@ module SurgeAPI
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageFailedWebhookEvent::Data::Conversation::OrHash,
             failed_at: Time,
@@ -169,7 +169,7 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
               failed_at: Time,

data/rbi/surge_api/models/message_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class MessageListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::MessageListParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Cursor for forward pagination. Use the next_cursor from a previous response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for backward pagination. Use the previous_cursor from a previous
+      # response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/message_received_webhook_event.rbi

@@ -79,7 +79,7 @@ module SurgeAPI
         attr_accessor :id
 
         # The content of the message
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :body
 
         # The conversation this message belongs to
@@ -132,7 +132,7 @@ module SurgeAPI
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation::OrHash,
             received_at: Time,
@@ -164,7 +164,7 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
               received_at: Time,

data/rbi/surge_api/models/message_sent_webhook_event.rbi

@@ -74,7 +74,7 @@ module SurgeAPI
         attr_accessor :id
 
         # The content of the message
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :body
 
         # The conversation this message belongs to
@@ -125,7 +125,7 @@ module SurgeAPI
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageSentWebhookEvent::Data::Conversation::OrHash,
             sent_at: Time,
@@ -157,7 +157,7 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
               sent_at: Time,

data/rbi/surge_api/models/phone_number_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::PhoneNumberListParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Cursor for forward pagination. Use the next_cursor from a previous response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for backward pagination. Use the previous_cursor from a previous
+      # response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

@@ -31,6 +31,8 @@ module SurgeAPI
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
 
+  ContactListParams = SurgeAPI::Models::ContactListParams
+
   ContactOptedInWebhookEvent = SurgeAPI::Models::ContactOptedInWebhookEvent
 
   ContactOptedOutWebhookEvent = SurgeAPI::Models::ContactOptedOutWebhookEvent
@@ -54,6 +56,8 @@ module SurgeAPI
 
   MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
 
+  MessageListParams = SurgeAPI::Models::MessageListParams
+
   MessageParams = SurgeAPI::Models::MessageParams
 
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
@@ -66,6 +70,8 @@ module SurgeAPI
 
   PhoneNumber = SurgeAPI::Models::PhoneNumber
 
+  PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
+
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
 
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent

data/rbi/surge_api/resources/blasts.rbi

@@ -9,7 +9,7 @@ module SurgeAPI
           account_id: String,
           attachments:
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
-          body: String,
+          body: T.nilable(String),
           contacts: T::Array[String],
           from: String,
           name: String,

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