surge_api 0.7.0 → 0.9.0

data/lib/surge_api/resources/blasts.rb

@@ -8,16 +8,18 @@ module SurgeAPI
       #
       # Sends a Blast.
       #
-      # @overload create(account_id, attachments: nil, body: nil, contacts: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
+      # @overload create(account_id, attachments: nil, body: nil, contacts: nil, from: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
       #
       # @param account_id [String] The account for which the blast should be sent.
       #
       # @param attachments [Array<SurgeAPI::Models::BlastCreateParams::Attachment>]
       #
-      # @param body [String] The message body.
+      # @param body [String, nil] The message body.
       #
       # @param contacts [Array<String>] Deprecated. Use `to` instead.
       #
+      # @param from [String] The phone number from which to send the blast. This can be either the phone numb
+      #
       # @param name [String] Optional name for the blast.
       #
       # @param segments [Array<String>] Deprecated. Use `to` instead.

data/lib/surge_api/resources/contacts.rb

@@ -88,6 +88,36 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::ContactListParams} for more details.
+      #
+      # List all contacts for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list contacts for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::Contact>]
+      #
+      # @see SurgeAPI::Models::ContactListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::ContactListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/contacts", account_id],
+          query: parsed,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Contact,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [SurgeAPI::Client]

data/lib/surge_api/resources/messages.rb

@@ -79,6 +79,36 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::MessageListParams} for more details.
+      #
+      # List all messages for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list messages for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::Message>]
+      #
+      # @see SurgeAPI::Models::MessageListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::MessageListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/messages", account_id],
+          query: parsed,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Message,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [SurgeAPI::Client]

data/lib/surge_api/resources/phone_numbers.rb

@@ -3,6 +3,36 @@
 module SurgeAPI
   module Resources
     class PhoneNumbers
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::PhoneNumberListParams} for more details.
+      #
+      # List all phone numbers for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list phone numbers for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::PhoneNumber>]
+      #
+      # @see SurgeAPI::Models::PhoneNumberListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::PhoneNumberListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/phone_numbers", account_id],
+          query: parsed,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::PhoneNumber,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::PhoneNumberPurchaseParams} for more details.
       #

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/surge_api.rb

@@ -52,6 +52,7 @@ require_relative "surge_api/errors"
 require_relative "surge_api/internal/transport/base_client"
 require_relative "surge_api/internal/transport/pooled_net_requester"
 require_relative "surge_api/client"
+require_relative "surge_api/internal/cursor"
 require_relative "surge_api/models/campaign_params"
 require_relative "surge_api/models/message_params"
 require_relative "surge_api/models/account"
@@ -68,6 +69,7 @@ require_relative "surge_api/models/campaign_approved_webhook_event"
 require_relative "surge_api/models/campaign_create_params"
 require_relative "surge_api/models/contact"
 require_relative "surge_api/models/contact_create_params"
+require_relative "surge_api/models/contact_list_params"
 require_relative "surge_api/models/contact_opted_in_webhook_event"
 require_relative "surge_api/models/contact_opted_out_webhook_event"
 require_relative "surge_api/models/contact_retrieve_params"
@@ -79,11 +81,13 @@ require_relative "surge_api/models/message"
 require_relative "surge_api/models/message_create_params"
 require_relative "surge_api/models/message_delivered_webhook_event"
 require_relative "surge_api/models/message_failed_webhook_event"
+require_relative "surge_api/models/message_list_params"
 require_relative "surge_api/models/message_received_webhook_event"
 require_relative "surge_api/models/message_retrieve_params"
 require_relative "surge_api/models/message_sent_webhook_event"
 require_relative "surge_api/models/organization"
 require_relative "surge_api/models/phone_number"
+require_relative "surge_api/models/phone_number_list_params"
 require_relative "surge_api/models/phone_number_purchase_params"
 require_relative "surge_api/models/unwrap_webhook_event"
 require_relative "surge_api/models/user"

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])) }
@@ -37,6 +34,15 @@ module SurgeAPI
       sig { params(contacts: T::Array[String]).void }
       attr_writer :contacts
 
+      # The phone number from which to send the blast. This can be either the phone
+      # number in E.164 format or a Surge phone number id. If not provided, the
+      # account's default phone number is used.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from
+
+      sig { params(from: String).void }
+      attr_writer :from
+
       # Optional name for the blast.
       sig { returns(T.nilable(String)) }
       attr_reader :name
@@ -70,8 +76,9 @@ module SurgeAPI
         params(
           attachments:
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
-          body: String,
+          body: T.nilable(String),
           contacts: T::Array[String],
+          from: String,
           name: String,
           segments: T::Array[String],
           send_at: Time,
@@ -85,6 +92,10 @@ module SurgeAPI
         body: nil,
         # Deprecated. Use `to` instead.
         contacts: nil,
+        # The phone number from which to send the blast. This can be either the phone
+        # number in E.164 format or a Surge phone number id. If not provided, the
+        # account's default phone number is used.
+        from: nil,
         # Optional name for the blast.
         name: nil,
         # Deprecated. Use `to` instead.
@@ -102,8 +113,9 @@ module SurgeAPI
         override.returns(
           {
             attachments: T::Array[SurgeAPI::BlastCreateParams::Attachment],
-            body: String,
+            body: T.nilable(String),
             contacts: T::Array[String],
+            from: String,
             name: String,
             segments: T::Array[String],
             send_at: Time,

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

@@ -23,12 +23,17 @@ module SurgeAPI
       end
       attr_writer :attachments
 
-      # The message body.
+      # The ID of the blast this message belongs to, if any. This can be used to
+      # attribute messages back to a specific blast.
       sig { returns(T.nilable(String)) }
-      attr_reader :body
+      attr_reader :blast_id
+
+      sig { params(blast_id: String).void }
+      attr_writer :blast_id
 
-      sig { params(body: String).void }
-      attr_writer :body
+      # The message body.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :body
 
       # A conversation with a Contact
       sig { returns(T.nilable(SurgeAPI::Message::Conversation)) }
@@ -49,7 +54,8 @@ module SurgeAPI
         params(
           id: String,
           attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
-          body: String,
+          blast_id: String,
+          body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
           metadata: T::Hash[Symbol, String]
         ).returns(T.attached_class)
@@ -58,6 +64,9 @@ module SurgeAPI
         # Unique identifier for the object.
         id: nil,
         attachments: nil,
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        blast_id: nil,
         # The message body.
         body: nil,
         # A conversation with a Contact
@@ -72,7 +81,8 @@ module SurgeAPI
           {
             id: String,
             attachments: T::Array[SurgeAPI::Message::Attachment],
-            body: String,
+            blast_id: 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
@@ -120,18 +120,27 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -144,7 +153,10 @@ module SurgeAPI
           # When the message was delivered
           delivered_at:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -152,14 +164,15 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment
-                ]
+                ],
+              blast_id: String
             }
           )
         end

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
@@ -122,11 +122,19 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
             id: String,
-            body: String,
+            body: T.nilable(String),
             conversation:
               SurgeAPI::MessageFailedWebhookEvent::Data::Conversation::OrHash,
             failed_at: Time,
@@ -134,7 +142,8 @@ module SurgeAPI
             attachments:
               T::Array[
                 SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -149,7 +158,10 @@ module SurgeAPI
           # The reason the message failed to be delivered
           failure_reason:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -157,13 +169,14 @@ module SurgeAPI
           override.returns(
             {
               id: String,
-              body: String,
+              body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
               failed_at: Time,
               failure_reason: String,
               attachments:
-                T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
+                T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
+              blast_id: String
             }
           )
         end

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