surge_api 0.23.0 → 0.25.0

data/sig/surge_api/models/phone_number.rbs

@@ -5,6 +5,7 @@ module SurgeAPI
         id: String,
         campaign: SurgeAPI::PhoneNumber::Campaign?,
         campaign_id: String?,
+        metadata: ::Hash[Symbol, String],
         name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_
@@ -17,6 +18,8 @@ module SurgeAPI
 
       attr_accessor campaign_id: String?
 
+      attr_accessor metadata: ::Hash[Symbol, String]
+
       attr_accessor name: String?
 
       attr_accessor number: String
@@ -27,6 +30,7 @@ module SurgeAPI
         id: String,
         campaign: SurgeAPI::PhoneNumber::Campaign?,
         campaign_id: String?,
+        metadata: ::Hash[Symbol, String],
         name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_
@@ -36,6 +40,7 @@ module SurgeAPI
         id: String,
         campaign: SurgeAPI::PhoneNumber::Campaign?,
         campaign_id: String?,
+        metadata: ::Hash[Symbol, String],
         name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_

data/sig/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbs

@@ -36,6 +36,7 @@ module SurgeAPI
           id: String,
           campaign: SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign?,
           campaign_id: String,
+          metadata: ::Hash[Symbol, String],
           name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
@@ -48,6 +49,8 @@ module SurgeAPI
 
         attr_accessor campaign_id: String
 
+        attr_accessor metadata: ::Hash[Symbol, String]
+
         attr_accessor name: String?
 
         attr_accessor number: String
@@ -58,6 +61,7 @@ module SurgeAPI
           id: String,
           campaign: SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign?,
           campaign_id: String,
+          metadata: ::Hash[Symbol, String],
           name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
@@ -67,6 +71,7 @@ module SurgeAPI
           id: String,
           campaign: SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign?,
           campaign_id: String,
+          metadata: ::Hash[Symbol, String],
           name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_

data/sig/surge_api/models/phone_number_imported_webhook_event.rbs

@@ -0,0 +1,130 @@
+module SurgeAPI
+  module Models
+    type phone_number_imported_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"phone_number.imported"
+      }
+
+    class PhoneNumberImportedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"phone_number.imported"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"phone_number.imported"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"phone_number.imported"
+      }
+
+      type data =
+        {
+          id: String,
+          campaign: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign?,
+          campaign_id: String?,
+          metadata: ::Hash[Symbol, String],
+          name: String?,
+          number: String,
+          type: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::type_
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor campaign: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign?
+
+        attr_accessor campaign_id: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]
+
+        attr_accessor name: String?
+
+        attr_accessor number: String
+
+        attr_accessor type: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::type_
+
+        def initialize: (
+          id: String,
+          campaign: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign?,
+          campaign_id: String?,
+          metadata: ::Hash[Symbol, String],
+          name: String?,
+          number: String,
+          type: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          campaign: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign?,
+          campaign_id: String?,
+          metadata: ::Hash[Symbol, String],
+          name: String?,
+          number: String,
+          type: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::type_
+        }
+
+        type campaign =
+          {
+            id: String,
+            attachment_status: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::attachment_status
+          }
+
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor attachment_status: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::attachment_status
+
+          def initialize: (
+            id: String,
+            attachment_status: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::attachment_status
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            attachment_status: SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::attachment_status
+          }
+
+          type attachment_status =
+            :attached | :attachment_pending | :detached | :detachment_pending
+
+          module AttachmentStatus
+            extend SurgeAPI::Internal::Type::Enum
+
+            ATTACHED: :attached
+            ATTACHMENT_PENDING: :attachment_pending
+            DETACHED: :detached
+            DETACHMENT_PENDING: :detachment_pending
+
+            def self?.values: -> ::Array[SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::attachment_status]
+          end
+        end
+
+        type type_ = :local | :short_code | :toll_free
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          LOCAL: :local
+          SHORT_CODE: :short_code
+          TOLL_FREE: :toll_free
+
+          def self?.values: -> ::Array[SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::type_]
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/phone_number_purchase_params.rbs

@@ -6,6 +6,7 @@ module SurgeAPI
         area_code: String,
         latitude: Float,
         longitude: Float,
+        metadata: ::Hash[Symbol, String],
         name: String,
         phone_number: String,
         type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_
@@ -30,6 +31,10 @@ module SurgeAPI
 
       def longitude=: (Float) -> Float
 
+      attr_reader metadata: ::Hash[Symbol, String]?
+
+      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
       attr_reader name: String?
 
       def name=: (String) -> String
@@ -49,6 +54,7 @@ module SurgeAPI
         ?area_code: String,
         ?latitude: Float,
         ?longitude: Float,
+        ?metadata: ::Hash[Symbol, String],
         ?name: String,
         ?phone_number: String,
         ?type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,
@@ -60,6 +66,7 @@ module SurgeAPI
         area_code: String,
         latitude: Float,
         longitude: Float,
+        metadata: ::Hash[Symbol, String],
         name: String,
         phone_number: String,
         type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,

data/sig/surge_api/models/phone_number_update_params.rbs

@@ -1,7 +1,12 @@
 module SurgeAPI
   module Models
     type phone_number_update_params =
-      { id: String, campaign_id: String, name: String }
+      {
+        id: String,
+        campaign_id: String,
+        metadata: ::Hash[Symbol, String],
+        name: String
+      }
       & SurgeAPI::Internal::Type::request_parameters
 
     class PhoneNumberUpdateParams < SurgeAPI::Internal::Type::BaseModel
@@ -14,6 +19,10 @@ module SurgeAPI
 
       def campaign_id=: (String) -> String
 
+      attr_reader metadata: ::Hash[Symbol, String]?
+
+      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
       attr_reader name: String?
 
       def name=: (String) -> String
@@ -21,6 +30,7 @@ module SurgeAPI
       def initialize: (
         id: String,
         ?campaign_id: String,
+        ?metadata: ::Hash[Symbol, String],
         ?name: String,
         ?request_options: SurgeAPI::request_opts
       ) -> void
@@ -28,6 +38,7 @@ module SurgeAPI
       def to_hash: -> {
         id: String,
         campaign_id: String,
+        metadata: ::Hash[Symbol, String],
         name: String,
         request_options: SurgeAPI::RequestOptions
       }

data/sig/surge_api/models/toll_free_campaign.rbs

@@ -0,0 +1,126 @@
+module SurgeAPI
+  module Models
+    type toll_free_campaign =
+      {
+        id: String,
+        consent_flows: ::Array[SurgeAPI::Models::toll_free_campaign_consent_flow],
+        description: String?,
+        includes: ::Array[SurgeAPI::Models::TollFreeCampaign::include_],
+        message_samples: ::Array[String],
+        phone_number_id: String,
+        privacy_policy_url: String?,
+        status: SurgeAPI::Models::TollFreeCampaign::status,
+        terms_and_conditions_url: String?,
+        use_cases: ::Array[SurgeAPI::Models::TollFreeCampaign::use_case]
+      }
+
+    class TollFreeCampaign < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor consent_flows: ::Array[SurgeAPI::Models::toll_free_campaign_consent_flow]
+
+      attr_accessor description: String?
+
+      attr_accessor includes: ::Array[SurgeAPI::Models::TollFreeCampaign::include_]
+
+      attr_accessor message_samples: ::Array[String]
+
+      attr_accessor phone_number_id: String
+
+      attr_accessor privacy_policy_url: String?
+
+      attr_accessor status: SurgeAPI::Models::TollFreeCampaign::status
+
+      attr_accessor terms_and_conditions_url: String?
+
+      attr_accessor use_cases: ::Array[SurgeAPI::Models::TollFreeCampaign::use_case]
+
+      def initialize: (
+        id: String,
+        consent_flows: ::Array[SurgeAPI::Models::toll_free_campaign_consent_flow],
+        description: String?,
+        includes: ::Array[SurgeAPI::Models::TollFreeCampaign::include_],
+        message_samples: ::Array[String],
+        phone_number_id: String,
+        privacy_policy_url: String?,
+        status: SurgeAPI::Models::TollFreeCampaign::status,
+        terms_and_conditions_url: String?,
+        use_cases: ::Array[SurgeAPI::Models::TollFreeCampaign::use_case]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        consent_flows: ::Array[SurgeAPI::Models::toll_free_campaign_consent_flow],
+        description: String?,
+        includes: ::Array[SurgeAPI::Models::TollFreeCampaign::include_],
+        message_samples: ::Array[String],
+        phone_number_id: String,
+        privacy_policy_url: String?,
+        status: SurgeAPI::Models::TollFreeCampaign::status,
+        terms_and_conditions_url: String?,
+        use_cases: ::Array[SurgeAPI::Models::TollFreeCampaign::use_case]
+      }
+
+      type include_ = :age_gated
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        AGE_GATED: :age_gated
+
+        def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaign::include_]
+      end
+
+      type status = :active | :canceled | :created | :in_review | :rejected
+
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACTIVE: :active
+        CANCELED: :canceled
+        CREATED: :created
+        IN_REVIEW: :in_review
+        REJECTED: :rejected
+
+        def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaign::status]
+      end
+
+      type use_case =
+        :two_factor_authentication
+        | :account_notification
+        | :customer_care
+        | :charity
+        | :delivery_notification
+        | :fraud_alert
+        | :event
+        | :higher_education
+        | :k12_education
+        | :marketing
+        | :polling_voting
+        | :political
+        | :public_service_announcement
+        | :security_alert
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        TWO_FACTOR_AUTHENTICATION: :two_factor_authentication
+        ACCOUNT_NOTIFICATION: :account_notification
+        CUSTOMER_CARE: :customer_care
+        CHARITY: :charity
+        DELIVERY_NOTIFICATION: :delivery_notification
+        FRAUD_ALERT: :fraud_alert
+        EVENT: :event
+        HIGHER_EDUCATION: :higher_education
+        K12_EDUCATION: :k12_education
+        MARKETING: :marketing
+        POLLING_VOTING: :polling_voting
+        POLITICAL: :political
+        PUBLIC_SERVICE_ANNOUNCEMENT: :public_service_announcement
+        SECURITY_ALERT: :security_alert
+
+        def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaign::use_case]
+      end
+    end
+  end
+end

data/sig/surge_api/models/toll_free_campaign_consent_flow.rbs

@@ -0,0 +1,207 @@
+module SurgeAPI
+  module Models
+    type toll_free_campaign_consent_flow =
+      SurgeAPI::TollFreeCampaignConsentFlow::UnionMember0
+      | SurgeAPI::TollFreeCampaignConsentFlow::UnionMember1
+      | SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2
+      | SurgeAPI::TollFreeCampaignConsentFlow::UnionMember3
+      | SurgeAPI::TollFreeCampaignConsentFlow::Type
+
+    module TollFreeCampaignConsentFlow
+      extend SurgeAPI::Internal::Type::Union
+
+      type union_member0 =
+        {
+          script: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::type_
+        }
+
+      class UnionMember0 < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor script: String
+
+        attr_accessor type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::type_
+
+        def initialize: (
+          script: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::type_
+        ) -> void
+
+        def to_hash: -> {
+          script: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::type_
+        }
+
+        type type_ = :verbal
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          VERBAL: :verbal
+
+          def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::type_]
+        end
+      end
+
+      type union_member1 =
+        {
+          form_url: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::type_
+        }
+
+      class UnionMember1 < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor form_url: String
+
+        attr_accessor type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::type_
+
+        def initialize: (
+          form_url: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::type_
+        ) -> void
+
+        def to_hash: -> {
+          form_url: String,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::type_
+        }
+
+        type type_ = :web_form
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          WEB_FORM: :web_form
+
+          def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::type_]
+        end
+      end
+
+      type union_member2 =
+        {
+          screenshot: SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::type_
+        }
+
+      class UnionMember2 < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor screenshot: SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot
+
+        attr_accessor type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::type_
+
+        def initialize: (
+          screenshot: SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::type_
+        ) -> void
+
+        def to_hash: -> {
+          screenshot: SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot,
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::type_
+        }
+
+        type screenshot =
+          {
+            reason: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::reason,
+            reason_other: String
+          }
+
+        class Screenshot < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor reason: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::reason
+
+          attr_reader reason_other: String?
+
+          def reason_other=: (String) -> String
+
+          def initialize: (
+            reason: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::reason,
+            ?reason_other: String
+          ) -> void
+
+          def to_hash: -> {
+            reason: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::reason,
+            reason_other: String
+          }
+
+          type reason = :behind_login | :under_construction | :other
+
+          module Reason
+            extend SurgeAPI::Internal::Type::Enum
+
+            BEHIND_LOGIN: :behind_login
+            UNDER_CONSTRUCTION: :under_construction
+            OTHER: :other
+
+            def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::reason]
+          end
+        end
+
+        type type_ = :web_form
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          WEB_FORM: :web_form
+
+          def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::type_]
+        end
+      end
+
+      type union_member3 =
+        {
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::type_,
+          keywords: ::Array[String]
+        }
+
+      class UnionMember3 < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::type_
+
+        attr_reader keywords: ::Array[String]?
+
+        def keywords=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::type_,
+          ?keywords: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::type_,
+          keywords: ::Array[String]
+        }
+
+        type type_ = :text
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TEXT: :text
+
+          def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::type_]
+        end
+      end
+
+      type type_ =
+        { type: SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::type_ }
+
+      class Type < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor type: SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::type_
+
+        def initialize: (
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::type_
+        ) -> void
+
+        def to_hash: -> {
+          type: SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::type_
+        }
+
+        type type_ = :paper_form
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          PAPER_FORM: :paper_form
+
+          def self?.values: -> ::Array[SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::type_]
+        end
+      end
+
+      def self?.variants: -> ::Array[SurgeAPI::Models::toll_free_campaign_consent_flow]
+    end
+  end
+end

data/sig/surge_api/models/toll_free_campaign_create_params.rbs

@@ -0,0 +1,25 @@
+module SurgeAPI
+  module Models
+    type toll_free_campaign_create_params =
+      { account_id: String } & SurgeAPI::Internal::Type::request_parameters
+
+    class TollFreeCampaignCreateParams < SurgeAPI::Models::TollFreeCampaignParams
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def account_id: -> String
+
+      def account_id=: (String _) -> String
+
+      def initialize: (
+        account_id: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models/toll_free_campaign_list_params.rbs

@@ -0,0 +1,36 @@
+module SurgeAPI
+  module Models
+    type toll_free_campaign_list_params =
+      { account_id: String, after: String, before: String }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class TollFreeCampaignListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_accessor account_id: String
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      def initialize: (
+        account_id: String,
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        after: String,
+        before: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end