surge_api 0.23.0 → 0.25.0

data/rbi/surge_api/models/phone_number_imported_webhook_event.rbi

@@ -0,0 +1,318 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberImportedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberImportedWebhookEvent,
+            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::PhoneNumberImportedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: SurgeAPI::PhoneNumberImportedWebhookEvent::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.imported` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::PhoneNumberImportedWebhookEvent::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.imported` for this event.
+        type: :"phone_number.imported"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the phone number
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Campaign attachment details for a domestic local phone number
+        sig do
+          returns(
+            T.nilable(SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign)
+          )
+        end
+        attr_reader :campaign
+
+        sig do
+          params(
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::OrHash
+              )
+          ).void
+        end
+        attr_writer :campaign
+
+        # Deprecated. The unique identifier of the campaign this phone number is attached
+        # to
+        sig { returns(T.nilable(String)) }
+        attr_accessor :campaign_id
+
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
+        # A human-readable name for the phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # 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::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::OrHash
+              ),
+            campaign_id: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            name: T.nilable(String),
+            number: String,
+            type:
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the phone number
+          id:,
+          # 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:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
+          # A human-readable name for the phone number
+          name:,
+          # 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:
+                T.nilable(
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign
+                ),
+              campaign_id: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              name: T.nilable(String),
+              number: String,
+              type:
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::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::PhoneNumberImportedWebhookEvent::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::PhoneNumberImportedWebhookEvent::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::PhoneNumberImportedWebhookEvent::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::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ATTACHED =
+              T.let(
+                :attached,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            ATTACHMENT_PENDING =
+              T.let(
+                :attachment_pending,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHED =
+              T.let(
+                :detached,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHMENT_PENDING =
+              T.let(
+                :detachment_pending,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::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
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOCAL =
+            T.let(
+              :local,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          SHORT_CODE =
+            T.let(
+              :short_code,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          TOLL_FREE =
+            T.let(
+              :toll_free,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -42,6 +42,13 @@ module SurgeAPI
       sig { params(longitude: Float).void }
       attr_writer :longitude
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # A human-readable name for the phone number. If not provided, defaults to the
       # formatted phone number.
       sig { returns(T.nilable(String)) }
@@ -76,6 +83,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          metadata: T::Hash[Symbol, String],
           name: String,
           phone_number: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
@@ -94,6 +102,8 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
         # A human-readable name for the phone number. If not provided, defaults to the
         # formatted phone number.
         name: nil,
@@ -114,6 +124,7 @@ module SurgeAPI
             area_code: String,
             latitude: Float,
             longitude: Float,
+            metadata: T::Hash[Symbol, String],
             name: String,
             phone_number: String,
             type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,

data/rbi/surge_api/models/phone_number_update_params.rbi

@@ -22,6 +22,13 @@ module SurgeAPI
       sig { params(campaign_id: String).void }
       attr_writer :campaign_id
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # A human-readable name for the phone number.
       sig { returns(T.nilable(String)) }
       attr_reader :name
@@ -33,6 +40,7 @@ module SurgeAPI
         params(
           id: String,
           campaign_id: String,
+          metadata: T::Hash[Symbol, String],
           name: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -42,6 +50,8 @@ module SurgeAPI
         id:,
         # Campaign ID to attach this number to (`cpn_...`).
         campaign_id: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
         # A human-readable name for the phone number.
         name: nil,
         request_options: {}
@@ -53,6 +63,7 @@ module SurgeAPI
           {
             id: String,
             campaign_id: String,
+            metadata: T::Hash[Symbol, String],
             name: String,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models/toll_free_campaign.rbi

@@ -0,0 +1,230 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class TollFreeCampaign < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::TollFreeCampaign, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The toll-free campaign ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T::Array[SurgeAPI::TollFreeCampaignConsentFlow::Variants]) }
+      attr_accessor :consent_flows
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig do
+        returns(T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol])
+      end
+      attr_accessor :includes
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :message_samples
+
+      # The toll-free phone number ID
+      sig { returns(String) }
+      attr_accessor :phone_number_id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :privacy_policy_url
+
+      # The current status of the toll-free campaign.
+      sig { returns(SurgeAPI::TollFreeCampaign::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :terms_and_conditions_url
+
+      sig do
+        returns(T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol])
+      end
+      attr_accessor :use_cases
+
+      # A toll-free campaign registration for a phone number.
+      sig do
+        params(
+          id: String,
+          consent_flows:
+            T::Array[
+              T.any(
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember0::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember1::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember3::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::Type::OrHash
+              )
+            ],
+          description: T.nilable(String),
+          includes: T::Array[SurgeAPI::TollFreeCampaign::Include::OrSymbol],
+          message_samples: T::Array[String],
+          phone_number_id: String,
+          privacy_policy_url: T.nilable(String),
+          status: SurgeAPI::TollFreeCampaign::Status::OrSymbol,
+          terms_and_conditions_url: T.nilable(String),
+          use_cases: T::Array[SurgeAPI::TollFreeCampaign::UseCase::OrSymbol]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The toll-free campaign ID
+        id:,
+        consent_flows:,
+        description:,
+        includes:,
+        message_samples:,
+        # The toll-free phone number ID
+        phone_number_id:,
+        privacy_policy_url:,
+        # The current status of the toll-free campaign.
+        status:,
+        terms_and_conditions_url:,
+        use_cases:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            consent_flows:
+              T::Array[SurgeAPI::TollFreeCampaignConsentFlow::Variants],
+            description: T.nilable(String),
+            includes:
+              T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol],
+            message_samples: T::Array[String],
+            phone_number_id: String,
+            privacy_policy_url: T.nilable(String),
+            status: SurgeAPI::TollFreeCampaign::Status::TaggedSymbol,
+            terms_and_conditions_url: T.nilable(String),
+            use_cases:
+              T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AGE_GATED =
+          T.let(:age_gated, SurgeAPI::TollFreeCampaign::Include::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The current status of the toll-free campaign.
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        CANCELED =
+          T.let(:canceled, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        CREATED =
+          T.let(:created, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        IN_REVIEW =
+          T.let(:in_review, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::UseCase) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TWO_FACTOR_AUTHENTICATION =
+          T.let(
+            :two_factor_authentication,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        ACCOUNT_NOTIFICATION =
+          T.let(
+            :account_notification,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        CUSTOMER_CARE =
+          T.let(
+            :customer_care,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        CHARITY =
+          T.let(:charity, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        DELIVERY_NOTIFICATION =
+          T.let(
+            :delivery_notification,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        FRAUD_ALERT =
+          T.let(:fraud_alert, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        EVENT = T.let(:event, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        HIGHER_EDUCATION =
+          T.let(
+            :higher_education,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        K12_EDUCATION =
+          T.let(
+            :k12_education,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        MARKETING =
+          T.let(:marketing, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        POLLING_VOTING =
+          T.let(
+            :polling_voting,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        POLITICAL =
+          T.let(:political, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        PUBLIC_SERVICE_ANNOUNCEMENT =
+          T.let(
+            :public_service_announcement,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        SECURITY_ALERT =
+          T.let(
+            :security_alert,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end