surge_api 0.11.0 → 0.13.0

data/rbi/surge_api/models/recording_list_response.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingListResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::RecordingListResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for the recording
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The call that produced this recording
+      sig { returns(SurgeAPI::Models::RecordingListResponse::Call) }
+      attr_reader :call
+
+      sig do
+        params(call: SurgeAPI::Models::RecordingListResponse::Call::OrHash).void
+      end
+      attr_writer :call
+
+      # The duration of the recording in seconds
+      sig { returns(Integer) }
+      attr_accessor :duration
+
+      # A call recording
+      sig do
+        params(
+          id: String,
+          call: SurgeAPI::Models::RecordingListResponse::Call::OrHash,
+          duration: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the recording
+        id:,
+        # The call that produced this recording
+        call:,
+        # The duration of the recording in seconds
+        duration:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            call: SurgeAPI::Models::RecordingListResponse::Call,
+            duration: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Call < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::Models::RecordingListResponse::Call,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the call
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A contact who has consented to receive messages
+        sig { returns(SurgeAPI::Contact) }
+        attr_reader :contact
+
+        sig { params(contact: SurgeAPI::Contact::OrHash).void }
+        attr_writer :contact
+
+        # The duration of the call in seconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # When the call was initiated
+        sig { returns(Time) }
+        attr_accessor :initiated_at
+
+        # The status of the call
+        sig do
+          returns(
+            SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The call that produced this recording
+        sig do
+          params(
+            id: String,
+            contact: SurgeAPI::Contact::OrHash,
+            duration: Integer,
+            initiated_at: Time,
+            status:
+              SurgeAPI::Models::RecordingListResponse::Call::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the call
+          id:,
+          # A contact who has consented to receive messages
+          contact:,
+          # The duration of the call in seconds
+          duration:,
+          # When the call was initiated
+          initiated_at:,
+          # The status of the call
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              contact: SurgeAPI::Contact,
+              duration: Integer,
+              initiated_at: Time,
+              status:
+                SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the call
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::Models::RecordingListResponse::Call::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSY =
+            T.let(
+              :busy,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          CANCELED =
+            T.let(
+              :canceled,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          MISSED =
+            T.let(
+              :missed,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          NO_ANSWER =
+            T.let(
+              :no_answer,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          QUEUED =
+            T.let(
+              :queued,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+          RINGING =
+            T.let(
+              :ringing,
+              SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::Models::RecordingListResponse::Call::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/recording_retrieve_params.rbi

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

data/rbi/surge_api/models/recording_retrieve_response.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingRetrieveResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::RecordingRetrieveResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for the recording
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The call that produced this recording
+      sig { returns(SurgeAPI::Models::RecordingRetrieveResponse::Call) }
+      attr_reader :call
+
+      sig do
+        params(
+          call: SurgeAPI::Models::RecordingRetrieveResponse::Call::OrHash
+        ).void
+      end
+      attr_writer :call
+
+      # The duration of the recording in seconds
+      sig { returns(Integer) }
+      attr_accessor :duration
+
+      # A call recording
+      sig do
+        params(
+          id: String,
+          call: SurgeAPI::Models::RecordingRetrieveResponse::Call::OrHash,
+          duration: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the recording
+        id:,
+        # The call that produced this recording
+        call:,
+        # The duration of the recording in seconds
+        duration:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            call: SurgeAPI::Models::RecordingRetrieveResponse::Call,
+            duration: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Call < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::Models::RecordingRetrieveResponse::Call,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the call
+        sig { returns(String) }
+        attr_accessor :id
+
+        # A contact who has consented to receive messages
+        sig { returns(SurgeAPI::Contact) }
+        attr_reader :contact
+
+        sig { params(contact: SurgeAPI::Contact::OrHash).void }
+        attr_writer :contact
+
+        # The duration of the call in seconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # When the call was initiated
+        sig { returns(Time) }
+        attr_accessor :initiated_at
+
+        # The status of the call
+        sig do
+          returns(
+            SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The call that produced this recording
+        sig do
+          params(
+            id: String,
+            contact: SurgeAPI::Contact::OrHash,
+            duration: Integer,
+            initiated_at: Time,
+            status:
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the call
+          id:,
+          # A contact who has consented to receive messages
+          contact:,
+          # The duration of the call in seconds
+          duration:,
+          # When the call was initiated
+          initiated_at:,
+          # The status of the call
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              contact: SurgeAPI::Contact,
+              duration: Integer,
+              initiated_at: Time,
+              status:
+                SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The status of the call
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::Models::RecordingRetrieveResponse::Call::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSY =
+            T.let(
+              :busy,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          CANCELED =
+            T.let(
+              :canceled,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          MISSED =
+            T.let(
+              :missed,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          NO_ANSWER =
+            T.let(
+              :no_answer,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          QUEUED =
+            T.let(
+              :queued,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+          RINGING =
+            T.let(
+              :ringing,
+              SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::Models::RecordingRetrieveResponse::Call::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/unwrap_webhook_event.rbi

@@ -18,6 +18,7 @@ module SurgeAPI
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,
             SurgeAPI::MessageSentWebhookEvent,
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent,
             SurgeAPI::RecordingCompletedWebhookEvent,
             SurgeAPI::VoicemailReceivedWebhookEvent
           )

data/rbi/surge_api/models/user_list_params.rbi

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

@@ -74,6 +74,9 @@ module SurgeAPI
 
   PhoneNumber = SurgeAPI::Models::PhoneNumber
 
+  PhoneNumberAttachedToCampaignWebhookEvent =
+    SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent
+
   PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
 
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
@@ -85,6 +88,10 @@ module SurgeAPI
 
   RecordingGetFileParams = SurgeAPI::Models::RecordingGetFileParams
 
+  RecordingListParams = SurgeAPI::Models::RecordingListParams
+
+  RecordingRetrieveParams = SurgeAPI::Models::RecordingRetrieveParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User
@@ -95,6 +102,8 @@ module SurgeAPI
 
   UserDeleteParams = SurgeAPI::Models::UserDeleteParams
 
+  UserListParams = SurgeAPI::Models::UserListParams
+
   UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
 
   UserTokenResponse = SurgeAPI::Models::UserTokenResponse

data/rbi/surge_api/resources/blasts.rbi

@@ -33,12 +33,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/resources/recordings.rbi

@@ -3,6 +3,43 @@
 module SurgeAPI
   module Resources
     class Recordings
+      # Retrieves a Recording object.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::RecordingRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the recording to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # List all recordings 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::Models::RecordingListResponse]
+        )
+      end
+      def list(
+        # The account ID to list recordings 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
+
       # Deletes a recording. The recording file will be removed from storage
       # asynchronously.
       sig do

data/rbi/surge_api/resources/users.rbi

@@ -69,6 +69,27 @@ module SurgeAPI
       )
       end
 
+      # List all users 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::User])
+      end
+      def list(
+        # The account ID to list users 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
+
       # Deletes a user.
       #
       # Once a user has been deleted, they will no longer be permitted to access any of

data/rbi/surge_api/resources/webhooks.rbi

@@ -16,6 +16,7 @@ module SurgeAPI
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,
             SurgeAPI::MessageSentWebhookEvent,
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent,
             SurgeAPI::RecordingCompletedWebhookEvent,
             SurgeAPI::VoicemailReceivedWebhookEvent
           )

data/sig/surge_api/internal/util.rbs

@@ -106,6 +106,16 @@ module SurgeAPI
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/surge_api/models/campaign.rbs

@@ -84,13 +84,7 @@ module SurgeAPI
       end
 
       type status =
-        :active
-        | :canceled
-        | :created
-        | :deactivated
-        | :in_review
-        | :pending
-        | :rejected
+        :active | :canceled | :created | :deactivated | :in_review | :rejected
 
       module Status
         extend SurgeAPI::Internal::Type::Enum
@@ -100,7 +94,6 @@ module SurgeAPI
         CREATED: :created
         DEACTIVATED: :deactivated
         IN_REVIEW: :in_review
-        PENDING: :pending
         REJECTED: :rejected
 
         def self?.values: -> ::Array[SurgeAPI::Models::Campaign::status]