surge_api 0.23.0 → 0.25.0

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -56,6 +56,12 @@ module SurgeAPI
         #   @return [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation]
         required :conversation, -> { SurgeAPI::MessageSentWebhookEvent::Data::Conversation }
 
+        # @!attribute failure_reason
+        #   The reason the message failed, or null if no failure reason is set
+        #
+        #   @return [String, nil]
+        required :failure_reason, String, nil?: true
+
         # @!attribute metadata
         #   Set of key-value pairs that will be stored with the object.
         #
@@ -68,6 +74,12 @@ module SurgeAPI
         #   @return [Time]
         required :sent_at, Time
 
+        # @!attribute status
+        #   The message status represented by this event
+        #
+        #   @return [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::MessageSentWebhookEvent::Data::Status }
+
         # @!attribute attachments
         #   Attachments included with the message
         #
@@ -82,7 +94,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, metadata:, sent_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, failure_reason:, metadata:, sent_at:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageSentWebhookEvent::Data} for more details.
         #
@@ -94,10 +106,14 @@ module SurgeAPI
         #
         #   @param conversation [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
+        #   @param failure_reason [String, nil] The reason the message failed, or null if no failure reason is set
+        #
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #
         #   @param sent_at [Time] When the message was sent
         #
+        #   @param status [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Status] The message status represented by this event
+        #
         #   @param attachments [Array<SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment>] Attachments included with the message
         #
         #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
@@ -132,6 +148,18 @@ module SurgeAPI
           #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
         end
 
+        # The message status represented by this event
+        #
+        # @see SurgeAPI::Models::MessageSentWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          SENT = :sent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the attachment

data/lib/surge_api/models/phone_number.rb

@@ -25,6 +25,12 @@ module SurgeAPI
       #   @return [String, nil]
       required :campaign_id, String, nil?: true
 
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
       # @!attribute name
       #   A human-readable name for the phone number
       #
@@ -43,7 +49,7 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::PhoneNumber::Type]
       required :type, enum: -> { SurgeAPI::PhoneNumber::Type }
 
-      # @!method initialize(id:, campaign:, campaign_id:, name:, number:, type:)
+      # @!method initialize(id:, campaign:, campaign_id:, metadata:, name:, number:, type:)
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::PhoneNumber} for more details.
       #
@@ -55,6 +61,8 @@ module SurgeAPI
       #
       #   @param campaign_id [String, nil] Deprecated. The unique identifier of the campaign this phone number is attached
       #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       #   @param name [String, nil] A human-readable name for the phone number
       #
       #   @param number [String] The phone number in E.164 format

data/lib/surge_api/models/phone_number_attached_to_campaign_webhook_event.rb

@@ -67,6 +67,12 @@ module SurgeAPI
         #   @return [String]
         required :campaign_id, String
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute name
         #   A human-readable name for the phone number
         #
@@ -85,7 +91,7 @@ module SurgeAPI
         #   @return [Symbol, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type]
         required :type, enum: -> { SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type }
 
-        # @!method initialize(id:, campaign:, campaign_id:, name:, number:, type:)
+        # @!method initialize(id:, campaign:, campaign_id:, metadata:, name:, number:, type:)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data} for more
         #   details.
@@ -98,6 +104,8 @@ module SurgeAPI
         #
         #   @param campaign_id [String] Deprecated. The unique identifier of the campaign this phone number is attached
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param name [String, nil] A human-readable name for the phone number
         #
         #   @param number [String] The phone number in E.164 format

data/lib/surge_api/models/phone_number_imported_webhook_event.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class PhoneNumberImportedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `phone_number.imported` for this event.
+      #
+      #   @return [Symbol, :"phone_number.imported"]
+      required :type, const: :"phone_number.imported"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"phone_number.imported")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"phone_number.imported"] The type of the event. Always `phone_number.imported` for this event.
+
+      # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the phone number
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute campaign
+        #   Campaign attachment details for a domestic local phone number
+        #
+        #   @return [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign, nil]
+        required :campaign, -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign }, nil?: true
+
+        # @!attribute campaign_id
+        #   @deprecated Use `campaign.id` instead.
+        #
+        #   Deprecated. The unique identifier of the campaign this phone number is attached
+        #   to
+        #
+        #   @return [String, nil]
+        required :campaign_id, String, nil?: true
+
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #   A human-readable name for the phone number
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute number
+        #   The phone number in E.164 format
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute type
+        #   Whether the phone number is local, toll-free, or short code
+        #
+        #   @return [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Type]
+        required :type, enum: -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type }
+
+        # @!method initialize(id:, campaign:, campaign_id:, metadata:, name:, number:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data} for more details.
+        #
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the phone number
+        #
+        #   @param campaign [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign, nil] Campaign attachment details for a domestic local phone number
+        #
+        #   @param campaign_id [String, nil] Deprecated. The unique identifier of the campaign this phone number is attached
+        #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
+        #   @param name [String, nil] A human-readable name for the phone number
+        #
+        #   @param number [String] The phone number in E.164 format
+        #
+        #   @param type [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Type] Whether the phone number is local, toll-free, or short code
+
+        # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data#campaign
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier of the campaign this phone number is attached to
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute attachment_status
+          #   The current campaign attachment status for this phone number.
+          #
+          #   @return [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus]
+          required :attachment_status,
+                   enum: -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus }
+
+          # @!method initialize(id:, attachment_status:)
+          #   Campaign attachment details for a domestic local phone number
+          #
+          #   @param id [String] The unique identifier of the campaign this phone number is attached to
+          #
+          #   @param attachment_status [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus] The current campaign attachment status for this phone number.
+
+          # The current campaign attachment status for this phone number.
+          #
+          # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign#attachment_status
+          module AttachmentStatus
+            extend SurgeAPI::Internal::Type::Enum
+
+            ATTACHED = :attached
+            ATTACHMENT_PENDING = :attachment_pending
+            DETACHED = :detached
+            DETACHMENT_PENDING = :detachment_pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Whether the phone number is local, toll-free, or short code
+        #
+        # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          LOCAL = :local
+          SHORT_CODE = :short_code
+          TOLL_FREE = :toll_free
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/phone_number_purchase_params.rb

@@ -34,6 +34,12 @@ module SurgeAPI
       #   @return [Float, nil]
       optional :longitude, Float
 
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
       # @!attribute name
       #   A human-readable name for the phone number. If not provided, defaults to the
       #   formatted phone number.
@@ -55,7 +61,7 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::PhoneNumberPurchaseParams::Type, nil]
       optional :type, enum: -> { SurgeAPI::PhoneNumberPurchaseParams::Type }
 
-      # @!method initialize(account_id:, area_code: nil, latitude: nil, longitude: nil, name: nil, phone_number: nil, type: nil, request_options: {})
+      # @!method initialize(account_id:, area_code: nil, latitude: nil, longitude: nil, metadata: nil, name: nil, phone_number: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::PhoneNumberPurchaseParams} for more details.
       #
@@ -67,6 +73,8 @@ module SurgeAPI
       #
       #   @param longitude [Float] Longitude to search for nearby phone numbers. Must be used with latitude. If pro
       #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       #   @param name [String] A human-readable name for the phone number. If not provided, defaults to the for
       #
       #   @param phone_number [String] The exact phone number to purchase in E.164 format. When provided, all other sea

data/lib/surge_api/models/phone_number_update_params.rb

@@ -19,17 +19,25 @@ module SurgeAPI
       #   @return [String, nil]
       optional :campaign_id, String
 
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
       # @!attribute name
       #   A human-readable name for the phone number.
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!method initialize(id:, campaign_id: nil, name: nil, request_options: {})
+      # @!method initialize(id:, campaign_id: nil, metadata: nil, name: nil, request_options: {})
       #   @param id [String] The ID of the phone number to update.
       #
       #   @param campaign_id [String] Campaign ID to attach this number to (`cpn_...`).
       #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       #   @param name [String] A human-readable name for the phone number.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models/toll_free_campaign.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::TollFreeCampaigns#create
+    class TollFreeCampaign < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The toll-free campaign ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute consent_flows
+      #
+      #   @return [Array<SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3, SurgeAPI::Models::TollFreeCampaignConsentFlow::Type>]
+      required :consent_flows,
+               -> { SurgeAPI::Internal::Type::ArrayOf[union: SurgeAPI::TollFreeCampaignConsentFlow] }
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute includes
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::TollFreeCampaign::Include>]
+      required :includes, -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::TollFreeCampaign::Include] }
+
+      # @!attribute message_samples
+      #
+      #   @return [Array<String>]
+      required :message_samples, SurgeAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute phone_number_id
+      #   The toll-free phone number ID
+      #
+      #   @return [String]
+      required :phone_number_id, String
+
+      # @!attribute privacy_policy_url
+      #
+      #   @return [String, nil]
+      required :privacy_policy_url, String, nil?: true
+
+      # @!attribute status
+      #   The current status of the toll-free campaign.
+      #
+      #   @return [Symbol, SurgeAPI::Models::TollFreeCampaign::Status]
+      required :status, enum: -> { SurgeAPI::TollFreeCampaign::Status }
+
+      # @!attribute terms_and_conditions_url
+      #
+      #   @return [String, nil]
+      required :terms_and_conditions_url, String, nil?: true
+
+      # @!attribute use_cases
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::TollFreeCampaign::UseCase>]
+      required :use_cases, -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::TollFreeCampaign::UseCase] }
+
+      # @!method initialize(id:, consent_flows:, description:, includes:, message_samples:, phone_number_id:, privacy_policy_url:, status:, terms_and_conditions_url:, use_cases:)
+      #   A toll-free campaign registration for a phone number.
+      #
+      #   @param id [String] The toll-free campaign ID
+      #
+      #   @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3, SurgeAPI::Models::TollFreeCampaignConsentFlow::Type>]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaign::Include>]
+      #
+      #   @param message_samples [Array<String>]
+      #
+      #   @param phone_number_id [String] The toll-free phone number ID
+      #
+      #   @param privacy_policy_url [String, nil]
+      #
+      #   @param status [Symbol, SurgeAPI::Models::TollFreeCampaign::Status] The current status of the toll-free campaign.
+      #
+      #   @param terms_and_conditions_url [String, nil]
+      #
+      #   @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaign::UseCase>]
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        AGE_GATED = :age_gated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The current status of the toll-free campaign.
+      #
+      # @see SurgeAPI::Models::TollFreeCampaign#status
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACTIVE = :active
+        CANCELED = :canceled
+        CREATED = :created
+        IN_REVIEW = :in_review
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/surge_api/models/toll_free_campaign_consent_flow.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # A consent flow returned on toll-free campaign responses.
+    module TollFreeCampaignConsentFlow
+      extend SurgeAPI::Internal::Type::Union
+
+      variant -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember0 }
+
+      variant -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember1 }
+
+      variant -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2 }
+
+      variant -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember3 }
+
+      variant -> { SurgeAPI::TollFreeCampaignConsentFlow::Type }
+
+      class UnionMember0 < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute script
+        #
+        #   @return [String]
+        required :script, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::Type]
+        required :type, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember0::Type }
+
+        # @!method initialize(script:, type:)
+        #   @param script [String]
+        #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0::Type]
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          VERBAL = :verbal
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class UnionMember1 < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute form_url
+        #
+        #   @return [String]
+        required :form_url, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::Type]
+        required :type, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember1::Type }
+
+        # @!method initialize(form_url:, type:)
+        #   @param form_url [String]
+        #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1::Type]
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          WEB_FORM = :web_form
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class UnionMember2 < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute screenshot
+        #
+        #   @return [SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot]
+        required :screenshot, -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Type]
+        required :type, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Type }
+
+        # @!method initialize(screenshot:, type:)
+        #   @param screenshot [SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot]
+        #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Type]
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2#screenshot
+        class Screenshot < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute reason
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::Reason]
+          required :reason, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::Reason }
+
+          # @!attribute reason_other
+          #
+          #   @return [String, nil]
+          optional :reason_other, String
+
+          # @!method initialize(reason:, reason_other: nil)
+          #   @param reason [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot::Reason]
+          #   @param reason_other [String]
+
+          # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2::Screenshot#reason
+          module Reason
+            extend SurgeAPI::Internal::Type::Enum
+
+            BEHIND_LOGIN = :behind_login
+            UNDER_CONSTRUCTION = :under_construction
+            OTHER = :other
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          WEB_FORM = :web_form
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class UnionMember3 < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::Type]
+        required :type, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::UnionMember3::Type }
+
+        # @!attribute keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :keywords, SurgeAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(type:, keywords: nil)
+        #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3::Type]
+        #   @param keywords [Array<String>]
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TEXT = :text
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class Type < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::Type]
+        required :type, enum: -> { SurgeAPI::TollFreeCampaignConsentFlow::Type::Type }
+
+        # @!method initialize(type:)
+        #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignConsentFlow::Type::Type]
+
+        # @see SurgeAPI::Models::TollFreeCampaignConsentFlow::Type#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          PAPER_FORM = :paper_form
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignConsentFlow::UnionMember3, SurgeAPI::Models::TollFreeCampaignConsentFlow::Type)]
+    end
+  end
+end

data/lib/surge_api/models/toll_free_campaign_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::TollFreeCampaigns#create
+    class TollFreeCampaignCreateParams < SurgeAPI::Models::TollFreeCampaignParams
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The account for which the toll-free campaign should be created.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String] The account for which the toll-free campaign should be created.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end