surge_api 0.10.0 → 0.12.0

data/lib/surge_api/resources/accounts.rb

@@ -111,10 +111,11 @@ module SurgeAPI
       # @see SurgeAPI::Models::AccountRetrieveStatusParams
       def retrieve_status(account_id, params = {})
         parsed, options = SurgeAPI::AccountRetrieveStatusParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["accounts/%1$s/status", account_id],
-          query: parsed,
+          query: query,
           model: SurgeAPI::AccountStatus,
           options: options
         )

data/lib/surge_api/resources/blasts.rb

@@ -22,7 +22,7 @@ module SurgeAPI
       #
       # @param name [String] Optional name for the blast.
       #
-      # @param segments [Array<String>] Deprecated. Use `to` instead.
+      # @param segments [Array<String>] Deprecated. Use `to` with audience IDs instead.
       #
       # @param send_at [Time] When to send the blast. If not provided, sends immediately.
       #

data/lib/surge_api/resources/campaigns.rb

@@ -55,6 +55,37 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::CampaignListParams} for more details.
+      #
+      # List all campaigns 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 campaigns 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::Campaign>]
+      #
+      # @see SurgeAPI::Models::CampaignListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::CampaignListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/campaigns", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Campaign,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [SurgeAPI::Client]

data/lib/surge_api/resources/contacts.rb

@@ -108,10 +108,11 @@ module SurgeAPI
       # @see SurgeAPI::Models::ContactListParams
       def list(account_id, params = {})
         parsed, options = SurgeAPI::ContactListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["accounts/%1$s/contacts", account_id],
-          query: parsed,
+          query: query,
           page: SurgeAPI::Internal::Cursor,
           model: SurgeAPI::Contact,
           options: options

data/lib/surge_api/resources/messages.rb

@@ -99,10 +99,11 @@ module SurgeAPI
       # @see SurgeAPI::Models::MessageListParams
       def list(account_id, params = {})
         parsed, options = SurgeAPI::MessageListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["accounts/%1$s/messages", account_id],
-          query: parsed,
+          query: query,
           page: SurgeAPI::Internal::Cursor,
           model: SurgeAPI::Message,
           options: options

data/lib/surge_api/resources/phone_numbers.rb

@@ -23,10 +23,11 @@ module SurgeAPI
       # @see SurgeAPI::Models::PhoneNumberListParams
       def list(account_id, params = {})
         parsed, options = SurgeAPI::PhoneNumberListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["accounts/%1$s/phone_numbers", account_id],
-          query: parsed,
+          query: query,
           page: SurgeAPI::Internal::Cursor,
           model: SurgeAPI::PhoneNumber,
           options: options

data/lib/surge_api/resources/recordings.rb

@@ -3,6 +3,27 @@
 module SurgeAPI
   module Resources
     class Recordings
+      # Deletes a recording. The recording file will be removed from storage
+      # asynchronously.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the recording.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::RecordingDeleteResponse]
+      #
+      # @see SurgeAPI::Models::RecordingDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["recordings/%1$s", id],
+          model: SurgeAPI::Models::RecordingDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Redirects to a signed URL where the recording audio file can be downloaded. URL
       # is short-lived, so redirect should be followed immediately.
       #

data/lib/surge_api/resources/webhooks.rb

@@ -5,7 +5,7 @@ module SurgeAPI
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
+      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
       def unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         SurgeAPI::Internal::Type::Converter.coerce(SurgeAPI::Models::UnwrapWebhookEvent, parsed)

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -67,6 +67,7 @@ require_relative "surge_api/models/call_ended_webhook_event"
 require_relative "surge_api/models/campaign"
 require_relative "surge_api/models/campaign_approved_webhook_event"
 require_relative "surge_api/models/campaign_create_params"
+require_relative "surge_api/models/campaign_list_params"
 require_relative "surge_api/models/campaign_retrieve_params"
 require_relative "surge_api/models/contact"
 require_relative "surge_api/models/contact_create_params"
@@ -88,9 +89,12 @@ 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_attached_to_campaign_webhook_event"
 require_relative "surge_api/models/phone_number_list_params"
 require_relative "surge_api/models/phone_number_purchase_params"
 require_relative "surge_api/models/recording_completed_webhook_event"
+require_relative "surge_api/models/recording_delete_params"
+require_relative "surge_api/models/recording_delete_response"
 require_relative "surge_api/models/recording_get_file_params"
 require_relative "surge_api/models/recording_get_file_response"
 require_relative "surge_api/models/unwrap_webhook_event"

data/rbi/surge_api/internal/util.rbi

@@ -301,6 +301,26 @@ module SurgeAPI
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: SurgeAPI::Internal::AnyHash).returns(
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: SurgeAPI::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/surge_api/models/blast_create_params.rbi

@@ -50,7 +50,7 @@ module SurgeAPI
       sig { params(name: String).void }
       attr_writer :name
 
-      # Deprecated. Use `to` instead.
+      # Deprecated. Use `to` with audience IDs instead.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :segments
 
@@ -65,7 +65,7 @@ module SurgeAPI
       attr_writer :send_at
 
       # List of recipients to whom the blast should be sent. This can be a combination
-      # of contact IDs, segment IDs, and phone numbers.
+      # of contact IDs, audience IDs, and phone numbers.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :to
 
@@ -98,12 +98,12 @@ module SurgeAPI
         from: nil,
         # Optional name for the blast.
         name: nil,
-        # Deprecated. Use `to` instead.
+        # Deprecated. Use `to` with audience IDs instead.
         segments: nil,
         # When to send the blast. If not provided, sends immediately.
         send_at: nil,
         # List of recipients to whom the blast should be sent. This can be a combination
-        # of contact IDs, segment IDs, and phone numbers.
+        # of contact IDs, audience IDs, and phone numbers.
         to: nil,
         request_options: {}
       )

data/rbi/surge_api/models/campaign.rbi

@@ -276,7 +276,6 @@ module SurgeAPI
         DEACTIVATED =
           T.let(:deactivated, SurgeAPI::Campaign::Status::TaggedSymbol)
         IN_REVIEW = T.let(:in_review, SurgeAPI::Campaign::Status::TaggedSymbol)
-        PENDING = T.let(:pending, SurgeAPI::Campaign::Status::TaggedSymbol)
         REJECTED = T.let(:rejected, SurgeAPI::Campaign::Status::TaggedSymbol)
 
         sig do

data/rbi/surge_api/models/campaign_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CampaignListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::CampaignListParams, 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

@@ -102,10 +102,12 @@ module SurgeAPI
         attr_writer :id
 
         # The type of attachment.
-        sig { returns(T.nilable(String)) }
+        sig do
+          returns(T.nilable(SurgeAPI::Message::Attachment::Type::TaggedSymbol))
+        end
         attr_reader :type
 
-        sig { params(type: String).void }
+        sig { params(type: SurgeAPI::Message::Attachment::Type::OrSymbol).void }
         attr_writer :type
 
         # The URL of the attachment.
@@ -117,9 +119,11 @@ module SurgeAPI
 
         # An Attachment is a file that can be sent with a message.
         sig do
-          params(id: String, type: String, url: String).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            type: SurgeAPI::Message::Attachment::Type::OrSymbol,
+            url: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # Unique identifier for the object.
@@ -131,9 +135,41 @@ module SurgeAPI
         )
         end
 
-        sig { override.returns({ id: String, type: String, url: String }) }
+        sig do
+          override.returns(
+            {
+              id: String,
+              type: SurgeAPI::Message::Attachment::Type::TaggedSymbol,
+              url: String
+            }
+          )
+        end
         def to_hash
         end
+
+        # The type of attachment.
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, SurgeAPI::Message::Attachment::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FILE = T.let(:file, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          IMAGE =
+            T.let(:image, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          LINK = T.let(:link, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          VIDEO =
+            T.let(:video, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[SurgeAPI::Message::Attachment::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class Conversation < SurgeAPI::Internal::Type::BaseModel

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -100,6 +100,10 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :delivered_at
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # Attachments included with the message
         sig do
           returns(
@@ -136,6 +140,7 @@ module SurgeAPI
             conversation:
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
+            metadata: T::Hash[Symbol, String],
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
@@ -152,6 +157,8 @@ module SurgeAPI
           conversation:,
           # When the message was delivered
           delivered_at:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -168,6 +175,7 @@ module SurgeAPI
               conversation:
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,
+              metadata: T::Hash[Symbol, String],
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment

data/rbi/surge_api/models/message_failed_webhook_event.rbi

@@ -102,6 +102,10 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :failure_reason
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # Attachments included with the message
         sig do
           returns(
@@ -139,6 +143,7 @@ module SurgeAPI
               SurgeAPI::MessageFailedWebhookEvent::Data::Conversation::OrHash,
             failed_at: Time,
             failure_reason: String,
+            metadata: T::Hash[Symbol, String],
             attachments:
               T::Array[
                 SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::OrHash
@@ -157,6 +162,8 @@ module SurgeAPI
           failed_at:,
           # The reason the message failed to be delivered
           failure_reason:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -174,6 +181,7 @@ module SurgeAPI
                 SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
               failed_at: Time,
               failure_reason: String,
+              metadata: T::Hash[Symbol, String],
               attachments:
                 T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
               blast_id: String

data/rbi/surge_api/models/message_received_webhook_event.rbi

@@ -96,6 +96,10 @@ module SurgeAPI
         end
         attr_writer :conversation
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # When the message was received
         sig { returns(Time) }
         attr_accessor :received_at
@@ -135,6 +139,7 @@ module SurgeAPI
             body: T.nilable(String),
             conversation:
               SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation::OrHash,
+            metadata: T::Hash[Symbol, String],
             received_at: Time,
             attachments:
               T::Array[
@@ -150,6 +155,8 @@ module SurgeAPI
           body:,
           # The conversation this message belongs to
           conversation:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # When the message was received
           received_at:,
           # Attachments included with the message
@@ -167,6 +174,7 @@ module SurgeAPI
               body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
+              metadata: T::Hash[Symbol, String],
               received_at: Time,
               attachments:
                 T::Array[

data/rbi/surge_api/models/message_sent_webhook_event.rbi

@@ -89,6 +89,10 @@ module SurgeAPI
         end
         attr_writer :conversation
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # When the message was sent
         sig { returns(Time) }
         attr_accessor :sent_at
@@ -128,6 +132,7 @@ module SurgeAPI
             body: T.nilable(String),
             conversation:
               SurgeAPI::MessageSentWebhookEvent::Data::Conversation::OrHash,
+            metadata: T::Hash[Symbol, String],
             sent_at: Time,
             attachments:
               T::Array[
@@ -143,6 +148,8 @@ module SurgeAPI
           body:,
           # The conversation this message belongs to
           conversation:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # When the message was sent
           sent_at:,
           # Attachments included with the message
@@ -160,6 +167,7 @@ module SurgeAPI
               body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
+              metadata: T::Hash[Symbol, String],
               sent_at: Time,
               attachments:
                 T::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],

data/rbi/surge_api/models/phone_number.rbi

@@ -12,6 +12,10 @@ module SurgeAPI
       sig { returns(String) }
       attr_accessor :id
 
+      # The unique identifier of the campaign this phone number is attached to, if any
+      sig { returns(T.nilable(String)) }
+      attr_accessor :campaign_id
+
       # The phone number in E.164 format
       sig { returns(String) }
       attr_accessor :number
@@ -24,6 +28,7 @@ module SurgeAPI
       sig do
         params(
           id: String,
+          campaign_id: T.nilable(String),
           number: String,
           type: SurgeAPI::PhoneNumber::Type::OrSymbol
         ).returns(T.attached_class)
@@ -31,6 +36,8 @@ module SurgeAPI
       def self.new(
         # Unique identifier for the phone number
         id:,
+        # The unique identifier of the campaign this phone number is attached to, if any
+        campaign_id:,
         # The phone number in E.164 format
         number:,
         # Whether the phone number is local, toll-free, or short code
@@ -42,6 +49,7 @@ module SurgeAPI
         override.returns(
           {
             id: String,
+            campaign_id: T.nilable(String),
             number: String,
             type: SurgeAPI::PhoneNumber::Type::TaggedSymbol
           }