surge_api 0.19.0 → 0.20.0

data/rbi/surge_api/models/phone_number.rbi

@@ -12,7 +12,19 @@ module SurgeAPI
       sig { returns(String) }
       attr_accessor :id
 
-      # The unique identifier of the campaign this phone number is attached to, if any
+      # Campaign attachment details for a domestic local phone number
+      sig { returns(T.nilable(SurgeAPI::PhoneNumber::Campaign)) }
+      attr_reader :campaign
+
+      sig do
+        params(
+          campaign: T.nilable(SurgeAPI::PhoneNumber::Campaign::OrHash)
+        ).void
+      end
+      attr_writer :campaign
+
+      # Deprecated. The unique identifier of the campaign this phone number is attached
+      # to, if any
       sig { returns(T.nilable(String)) }
       attr_accessor :campaign_id
 
@@ -32,6 +44,7 @@ module SurgeAPI
       sig do
         params(
           id: String,
+          campaign: T.nilable(SurgeAPI::PhoneNumber::Campaign::OrHash),
           campaign_id: T.nilable(String),
           name: T.nilable(String),
           number: String,
@@ -41,7 +54,10 @@ 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 attachment details for a domestic local phone number
+        campaign:,
+        # Deprecated. The unique identifier of the campaign this phone number is attached
+        # to, if any
         campaign_id:,
         # A human-readable name for the phone number
         name:,
@@ -56,6 +72,7 @@ module SurgeAPI
         override.returns(
           {
             id: String,
+            campaign: T.nilable(SurgeAPI::PhoneNumber::Campaign),
             campaign_id: T.nilable(String),
             name: T.nilable(String),
             number: String,
@@ -66,6 +83,95 @@ module SurgeAPI
       def to_hash
       end
 
+      class Campaign < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SurgeAPI::PhoneNumber::Campaign, SurgeAPI::Internal::AnyHash)
+          end
+
+        # The unique identifier of the campaign this phone number is attached to
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The current campaign attachment status for this phone number.
+        sig do
+          returns(
+            SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+          )
+        end
+        attr_accessor :attachment_status
+
+        # Campaign attachment details for a domestic local phone number
+        sig do
+          params(
+            id: String,
+            attachment_status:
+              SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the campaign this phone number is attached to
+          id:,
+          # The current campaign attachment status for this phone number.
+          attachment_status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              attachment_status:
+                SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The current campaign attachment status for this phone number.
+        module AttachmentStatus
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, SurgeAPI::PhoneNumber::Campaign::AttachmentStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ATTACHED =
+            T.let(
+              :attached,
+              SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+            )
+          ATTACHMENT_PENDING =
+            T.let(
+              :attachment_pending,
+              SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+            )
+          DETACHED =
+            T.let(
+              :detached,
+              SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+            )
+          DETACHMENT_PENDING =
+            T.let(
+              :detachment_pending,
+              SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::PhoneNumber::Campaign::AttachmentStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # Whether the phone number is local, toll-free, or short code
       module Type
         extend SurgeAPI::Internal::Type::Enum

data/rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi

@@ -84,7 +84,28 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :id
 
-        # The unique identifier of the campaign this phone number is attached to
+        # Campaign attachment details for a domestic local phone number
+        sig do
+          returns(
+            T.nilable(
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign
+            )
+          )
+        end
+        attr_reader :campaign
+
+        sig do
+          params(
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::OrHash
+              )
+          ).void
+        end
+        attr_writer :campaign
+
+        # Deprecated. The unique identifier of the campaign this phone number is attached
+        # to
         sig { returns(String) }
         attr_accessor :campaign_id
 
@@ -108,6 +129,10 @@ module SurgeAPI
         sig do
           params(
             id: String,
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::OrHash
+              ),
             campaign_id: String,
             name: T.nilable(String),
             number: String,
@@ -118,7 +143,10 @@ module SurgeAPI
         def self.new(
           # The unique identifier for the phone number
           id:,
-          # The unique identifier of the campaign this phone number is attached to
+          # Campaign attachment details for a domestic local phone number
+          campaign:,
+          # Deprecated. The unique identifier of the campaign this phone number is attached
+          # to
           campaign_id:,
           # A human-readable name for the phone number
           name:,
@@ -133,6 +161,10 @@ module SurgeAPI
           override.returns(
             {
               id: String,
+              campaign:
+                T.nilable(
+                  SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign
+                ),
               campaign_id: String,
               name: T.nilable(String),
               number: String,
@@ -144,6 +176,101 @@ module SurgeAPI
         def to_hash
         end
 
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier of the campaign this phone number is attached to
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The current campaign attachment status for this phone number.
+          sig do
+            returns(
+              SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :attachment_status
+
+          # Campaign attachment details for a domestic local phone number
+          sig do
+            params(
+              id: String,
+              attachment_status:
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier of the campaign this phone number is attached to
+            id:,
+            # The current campaign attachment status for this phone number.
+            attachment_status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                attachment_status:
+                  SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current campaign attachment status for this phone number.
+          module AttachmentStatus
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ATTACHED =
+              T.let(
+                :attached,
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            ATTACHMENT_PENDING =
+              T.let(
+                :attachment_pending,
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHED =
+              T.let(
+                :detached,
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHMENT_PENDING =
+              T.let(
+                :detachment_pending,
+                SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # Whether the phone number is local, toll-free, or short code
         module Type
           extend SurgeAPI::Internal::Type::Enum

data/rbi/surge_api/models/phone_number_list_available_numbers_params.rbi

@@ -0,0 +1,183 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberListAvailableNumbersParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberListAvailableNumbersParams,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The account ID to list available phone numbers for.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # Whether to search for local or toll-free numbers.
+      sig do
+        returns(SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::OrSymbol)
+      end
+      attr_accessor :type
+
+      # 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
+
+      # Filter by 3-digit area code.
+      sig { returns(T.nilable(String)) }
+      attr_reader :area_code
+
+      sig { params(area_code: String).void }
+      attr_writer :area_code
+
+      # 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
+
+      # ISO country code to search in.
+      sig do
+        returns(
+          T.nilable(
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::OrSymbol
+          )
+        )
+      end
+      attr_reader :country
+
+      sig do
+        params(
+          country:
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::OrSymbol
+        ).void
+      end
+      attr_writer :country
+
+      sig do
+        params(
+          account_id: String,
+          type: SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::OrSymbol,
+          after: String,
+          area_code: String,
+          before: String,
+          country:
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::OrSymbol,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account ID to list available phone numbers for.
+        account_id:,
+        # Whether to search for local or toll-free numbers.
+        type:,
+        # Cursor for forward pagination. Use the next_cursor from a previous response.
+        after: nil,
+        # Filter by 3-digit area code.
+        area_code: nil,
+        # Cursor for backward pagination. Use the previous_cursor from a previous
+        # response.
+        before: nil,
+        # ISO country code to search in.
+        country: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            type:
+              SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::OrSymbol,
+            after: String,
+            area_code: String,
+            before: String,
+            country:
+              SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::OrSymbol,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether to search for local or toll-free numbers.
+      module Type
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, SurgeAPI::PhoneNumberListAvailableNumbersParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCAL =
+          T.let(
+            :local,
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::TaggedSymbol
+          )
+        TOLL_FREE =
+          T.let(
+            :toll_free,
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SurgeAPI::PhoneNumberListAvailableNumbersParams::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # ISO country code to search in.
+      module Country
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              SurgeAPI::PhoneNumberListAvailableNumbersParams::Country
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        US =
+          T.let(
+            :US,
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::TaggedSymbol
+          )
+        CA =
+          T.let(
+            :CA,
+            SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SurgeAPI::PhoneNumberListAvailableNumbersParams::Country::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/phone_number_list_available_numbers_response.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberListAvailableNumbersResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # ISO country code for the phone number
+      sig do
+        returns(
+          SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::TaggedSymbol
+        )
+      end
+      attr_accessor :country
+
+      # The phone number in E.164 format
+      sig { returns(String) }
+      attr_accessor :number
+
+      # Whether the phone number is local or toll-free
+      sig do
+        returns(
+          SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      # A phone number available for purchase from Surge inventory
+      sig do
+        params(
+          country:
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::OrSymbol,
+          number: String,
+          type:
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ISO country code for the phone number
+        country:,
+        # The phone number in E.164 format
+        number:,
+        # Whether the phone number is local or toll-free
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            country:
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::TaggedSymbol,
+            number: String,
+            type:
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # ISO country code for the phone number
+      module Country
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        US =
+          T.let(
+            :US,
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::TaggedSymbol
+          )
+        CA =
+          T.let(
+            :CA,
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Whether the phone number is local or toll-free
+      module Type
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCAL =
+          T.let(
+            :local,
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::TaggedSymbol
+          )
+        TOLL_FREE =
+          T.let(
+            :toll_free,
+            SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -50,6 +50,14 @@ module SurgeAPI
       sig { params(name: String).void }
       attr_writer :name
 
+      # The exact phone number to purchase in E.164 format. When provided, all other
+      # search parameters are ignored.
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number
+
+      sig { params(phone_number: String).void }
+      attr_writer :phone_number
+
       # Whether the phone number is local or toll-free. Can be omitted if area_code or
       # latitude/longitude are provided.
       sig do
@@ -69,6 +77,7 @@ module SurgeAPI
           latitude: Float,
           longitude: Float,
           name: String,
+          phone_number: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -88,6 +97,9 @@ module SurgeAPI
         # A human-readable name for the phone number. If not provided, defaults to the
         # formatted phone number.
         name: nil,
+        # The exact phone number to purchase in E.164 format. When provided, all other
+        # search parameters are ignored.
+        phone_number: nil,
         # Whether the phone number is local or toll-free. Can be omitted if area_code or
         # latitude/longitude are provided.
         type: nil,
@@ -103,6 +115,7 @@ module SurgeAPI
             latitude: Float,
             longitude: Float,
             name: String,
+            phone_number: String,
             type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models/phone_number_retrieve_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberRetrieveParams,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the phone number to retrieve.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the phone number to retrieve.
+        id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: SurgeAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end