surge_api 0.11.0 → 0.13.0

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,57 @@
 module SurgeAPI
   module Resources
     class Recordings
+      # Retrieves a Recording object.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the recording to retrieve.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::RecordingRetrieveResponse]
+      #
+      # @see SurgeAPI::Models::RecordingRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["recordings/%1$s", id],
+          model: SurgeAPI::Models::RecordingRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::RecordingListParams} for more details.
+      #
+      # List all recordings 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 recordings 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::RecordingListResponse>]
+      #
+      # @see SurgeAPI::Models::RecordingListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::RecordingListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/recordings", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Models::RecordingListResponse,
+          options: options
+        )
+      end
+
       # Deletes a recording. The recording file will be removed from storage
       # asynchronously.
       #

data/lib/surge_api/resources/users.rb

@@ -83,6 +83,37 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::UserListParams} for more details.
+      #
+      # List all users 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 users 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::User>]
+      #
+      # @see SurgeAPI::Models::UserListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::UserListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/users", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::User,
+          options: options
+        )
+      end
+
       # Deletes a user.
       #
       # Once a user has been deleted, they will no longer be permitted to access any of

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.11.0"
+  VERSION = "0.13.0"
 end

data/lib/surge_api.rb

@@ -89,6 +89,7 @@ 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"
@@ -96,11 +97,16 @@ 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/recording_list_params"
+require_relative "surge_api/models/recording_list_response"
+require_relative "surge_api/models/recording_retrieve_params"
+require_relative "surge_api/models/recording_retrieve_response"
 require_relative "surge_api/models/unwrap_webhook_event"
 require_relative "surge_api/models/user"
 require_relative "surge_api/models/user_create_params"
 require_relative "surge_api/models/user_create_token_params"
 require_relative "surge_api/models/user_delete_params"
+require_relative "surge_api/models/user_list_params"
 require_relative "surge_api/models/user_retrieve_params"
 require_relative "surge_api/models/user_token_response"
 require_relative "surge_api/models/user_update_params"

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

data/rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi

@@ -0,0 +1,181 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberAttachedToCampaignWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the account in which this event occurred
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The data associated with the event
+      sig { returns(SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `phone_number.attached_to_campaign` for this
+      # event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data:
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account in which this event occurred
+        account_id:,
+        # The data associated with the event
+        data:,
+        # The timestamp when this event occurred, in ISO8601 format
+        timestamp:,
+        # The type of the event. Always `phone_number.attached_to_campaign` for this
+        # event.
+        type: :"phone_number.attached_to_campaign"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the phone number
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The unique identifier of the campaign this phone number is attached to
+        sig { returns(String) }
+        attr_accessor :campaign_id
+
+        # The phone number in E.164 format
+        sig { returns(String) }
+        attr_accessor :number
+
+        # Whether the phone number is local, toll-free, or short code
+        sig do
+          returns(
+            SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            campaign_id: String,
+            number: String,
+            type:
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the phone number
+          id:,
+          # The unique identifier of the campaign this phone number is attached to
+          campaign_id:,
+          # The phone number in E.164 format
+          number:,
+          # Whether the phone number is local, toll-free, or short code
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              campaign_id: String,
+              number: String,
+              type:
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the phone number is local, toll-free, or short code
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOCAL =
+            T.let(
+              :local,
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+            )
+          SHORT_CODE =
+            T.let(
+              :short_code,
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+            )
+          TOLL_FREE =
+            T.let(
+              :toll_free,
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/recording_list_params.rbi

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