surge_api 0.24.0 → 0.25.0

data/lib/surge_api/models/campaign_update_params.rb

@@ -13,10 +13,197 @@ module SurgeAPI
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute consent_flow
+      #   A string explaining the method through which end users will opt in to receive
+      #   messages from the brand. Typically this should include URLs for opt-in forms or
+      #   screenshots that might be helpful in explaining the flow to someone unfamiliar
+      #   with the organization's purpose.
+      #
+      #   @return [String, nil]
+      optional :consent_flow, String
+
+      # @!attribute description
+      #   An explanation of the organization's purpose and how it will be using text
+      #   messaging to accomplish that purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute includes
+      #   A list of properties that this campaign should include. These properties can be
+      #   any of the following values:
+      #
+      #   - `links` - whether the campaign might send links in messages
+      #   - `phone_numbers` - whether the campaign might send phone numbers in messages
+      #   - `age_gated` - whether the campaign contains age gated content (controlled
+      #     substances or adult content)
+      #   - `direct_lending` - whether the campaign contains content related to direct
+      #     lending or other loan arrangements
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::Include>, nil]
+      optional :includes,
+               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignUpdateParams::Include] }
+
+      # @!attribute link_sample
+      #   A sample link that might be sent by this campaign. This is required when
+      #   `includes` contains `links`. Provide the same URL or domain that the campaign
+      #   will use in production. If links from other domains are sent through this
+      #   campaign, they are much more likely to be filtered by the carriers.
+      #
+      #   @return [String, nil]
+      optional :link_sample, String, nil?: true
+
+      # @!attribute message_samples
+      #   An array of 2-5 strings with examples of the messages that will be sent from
+      #   this campaign. Typically the first sample should be a compliance message like
+      #   `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
+      #   These samples don't necessarily need to be the only templates that will be used
+      #   for the campaign, but they should reflect the purpose of the messages that will
+      #   be sent. Any variable content can be reflected by wrapping it in square brackets
+      #   like `[customer name]`.
+      #
+      #   @return [Array<String>, nil]
+      optional :message_samples, SurgeAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute privacy_policy_url
+      #   The URL of the privacy policy for the brand in question. This may be a shared
+      #   privacy policy if it's the policy that is displayed to end users when they opt
+      #   in to messaging.
+      #
+      #   @return [String, nil]
+      optional :privacy_policy_url, String
+
+      # @!attribute terms_and_conditions_url
+      #   The URL of the terms and conditions presented to end users when they opt in to
+      #   messaging. These terms and conditions may be shared among all of a platform's
+      #   customers if they're the terms that are presented to end users when they opt in
+      #   to messaging.
+      #
+      #   @return [String, nil]
+      optional :terms_and_conditions_url, String
+
+      # @!attribute use_cases
+      #   A list containing 1-5 types of messages that will be sent with this campaign.
+      #
+      #   The following use cases are typically available to all brands:
+      #
+      #   - `account_notification` - For sending reminders, alerts, and general
+      #     account-related notifications like booking confirmations or appointment
+      #     reminders.
+      #   - `customer_care` - For account support, troubleshooting, and general customer
+      #     service communication.
+      #   - `delivery_notification` - For notifying customers about the status of product
+      #     or service deliveries.
+      #   - `fraud_alert` - For warning customers about suspicious or potentially
+      #     fraudulent activity.
+      #   - `higher_education` - For messaging related to colleges, universities, and
+      #     school districts outside of K–12.
+      #   - `marketing` - For promotional or advertising messages intended to market
+      #     products or services.
+      #   - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
+      #   - `public_service_announcement` - For raising awareness about social issues or
+      #     important public information.
+      #   - `security_alert` - For alerts related to potential security breaches or
+      #     compromised systems requiring user action.
+      #   - `two_factor_authentication` - For sending one-time passwords or verification
+      #     codes for login or password reset.
+      #
+      #   For access to special use cases not shown here, reach out to support@surge.app.
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::UseCase>, nil]
+      optional :use_cases,
+               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignUpdateParams::UseCase] }
+
+      # @!attribute volume
+      #   This will be one of the following:
+      #
+      #   - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+      #     T-Mobile customers each day. In this case your project will be charged for the
+      #     setup fee for a low volume number upon receipt of the API request.
+      #   - `high` - The campaign will be allowed to send up to 200k SMS segments to
+      #     T-Mobile customers each day, depending on the trust score assigned by The
+      #     Campaign Registry. Your project will be charged for the setup fee for a high
+      #     volume number upon receipt of the API request, and phone numbers will be
+      #     charged as high volume numbers going forward.
+      #
+      #   @return [Symbol, SurgeAPI::Models::CampaignUpdateParams::Volume, nil]
+      optional :volume, enum: -> { SurgeAPI::CampaignUpdateParams::Volume }
+
+      # @!method initialize(id:, consent_flow: nil, description: nil, includes: nil, link_sample: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil, volume: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::CampaignUpdateParams} for more details.
+      #
       #   @param id [String] The ID of the campaign to update.
       #
+      #   @param consent_flow [String] A string explaining the method through which end users will opt in to receive me
+      #
+      #   @param description [String] An explanation of the organization's purpose and how it will be using text messa
+      #
+      #   @param includes [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::Include>] A list of properties that this campaign should include. These properties can be
+      #
+      #   @param link_sample [String, nil] A sample link that might be sent by this campaign. This is required when `includ
+      #
+      #   @param message_samples [Array<String>] An array of 2-5 strings with examples of the messages that will be sent from thi
+      #
+      #   @param privacy_policy_url [String] The URL of the privacy policy for the brand in question. This may be a shared pr
+      #
+      #   @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+      #
+      #   @param use_cases [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+      #
+      #   @param volume [Symbol, SurgeAPI::Models::CampaignUpdateParams::Volume] This will be one of the following:
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        LINKS = :links
+        PHONE_NUMBERS = :phone_numbers
+        AGE_GATED = :age_gated
+        DIRECT_LENDING = :direct_lending
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACCOUNT_NOTIFICATION = :account_notification
+        CUSTOMER_CARE = :customer_care
+        DELIVERY_NOTIFICATION = :delivery_notification
+        FRAUD_ALERT = :fraud_alert
+        HIGHER_EDUCATION = :higher_education
+        MARKETING = :marketing
+        POLLING_VOTING = :polling_voting
+        PUBLIC_SERVICE_ANNOUNCEMENT = :public_service_announcement
+        SECURITY_ALERT = :security_alert
+        TWO_FACTOR_AUTHENTICATION = :two_factor_authentication
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # This will be one of the following:
+      #
+      # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+      #   T-Mobile customers each day. In this case your project will be charged for the
+      #   setup fee for a low volume number upon receipt of the API request.
+      # - `high` - The campaign will be allowed to send up to 200k SMS segments to
+      #   T-Mobile customers each day, depending on the trust score assigned by The
+      #   Campaign Registry. Your project will be charged for the setup fee for a high
+      #   volume number upon receipt of the API request, and phone numbers will be
+      #   charged as high volume numbers going forward.
+      module Volume
+        extend SurgeAPI::Internal::Type::Enum
+
+        HIGH = :high
+        LOW = :low
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/surge_api/models/campaign_warning_webhook_event.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class CampaignWarningWebhookEvent < 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::CampaignWarningWebhookEvent::Data]
+      required :data, -> { SurgeAPI::CampaignWarningWebhookEvent::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 `campaign.warning` for this event.
+      #
+      #   @return [Symbol, :"campaign.warning"]
+      required :type, const: :"campaign.warning"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"campaign.warning")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::CampaignWarningWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"campaign.warning"] The type of the event. Always `campaign.warning` for this event.
+
+      # @see SurgeAPI::Models::CampaignWarningWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the campaign
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute feedback
+        #   Customer-visible field-level registration feedback. Rejection events may include
+        #   non-blocking warnings alongside changes-needed items.
+        #
+        #   @return [Array<SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback>]
+        required :feedback,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback] }
+
+        # @!attribute status
+        #   The public campaign status. Always `in_review` for this event.
+        #
+        #   @return [Symbol, SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::CampaignWarningWebhookEvent::Data::Status }
+
+        # @!method initialize(id:, feedback:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::CampaignWarningWebhookEvent::Data} for more details.
+        #
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the campaign
+        #
+        #   @param feedback [Array<SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback>] Customer-visible field-level registration feedback. Rejection events may include
+        #
+        #   @param status [Symbol, SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Status] The public campaign status. Always `in_review` for this event.
+
+        class Feedback < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute field
+          #   The stable registration field key
+          #
+          #   @return [String]
+          required :field, String
+
+          # @!attribute message
+          #   Actionable review feedback
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute outcome
+          #   Whether the feedback blocks registration or is a non-blocking warning
+          #
+          #   @return [Symbol, SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::Outcome]
+          required :outcome, enum: -> { SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback::Outcome }
+
+          # @!attribute suggested_value
+          #   A suggested replacement value, or null when none is suggested
+          #
+          #   @return [String, nil]
+          required :suggested_value, String, nil?: true
+
+          # @!method initialize(field:, message:, outcome:, suggested_value:)
+          #   @param field [String] The stable registration field key
+          #
+          #   @param message [String] Actionable review feedback
+          #
+          #   @param outcome [Symbol, SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::Outcome] Whether the feedback blocks registration or is a non-blocking warning
+          #
+          #   @param suggested_value [String, nil] A suggested replacement value, or null when none is suggested
+
+          # Whether the feedback blocks registration or is a non-blocking warning
+          #
+          # @see SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback#outcome
+          module Outcome
+            extend SurgeAPI::Internal::Type::Enum
+
+            WARNING = :warning
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The public campaign status. Always `in_review` for this event.
+        #
+        # @see SurgeAPI::Models::CampaignWarningWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          IN_REVIEW = :in_review
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/message.rb

@@ -34,6 +34,12 @@ module SurgeAPI
       #   @return [SurgeAPI::Models::Message::Conversation, nil]
       optional :conversation, -> { SurgeAPI::Message::Conversation }
 
+      # @!attribute failure_reason
+      #   The reason the message failed, or null if no failure reason is set.
+      #
+      #   @return [String, nil]
+      optional :failure_reason, String, nil?: true
+
       # @!attribute metadata
       #   Set of key-value pairs that will be stored with the object.
       #
@@ -46,7 +52,7 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::Message::Status, nil]
       optional :status, enum: -> { SurgeAPI::Message::Status }
 
-      # @!method initialize(id: nil, attachments: nil, blast_id: nil, body: nil, conversation: nil, metadata: nil, status: nil)
+      # @!method initialize(id: nil, attachments: nil, blast_id: nil, body: nil, conversation: nil, failure_reason: nil, metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::Message} for more details.
       #
@@ -62,6 +68,8 @@ module SurgeAPI
       #
       #   @param conversation [SurgeAPI::Models::Message::Conversation] A conversation with a Contact
       #
+      #   @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 status [Symbol, SurgeAPI::Models::Message::Status] The current status of the message.
@@ -148,6 +156,12 @@ module SurgeAPI
           #   @return [String]
           required :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
           #
@@ -166,11 +180,13 @@ module SurgeAPI
           #   @return [Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type]
           required :type, enum: -> { SurgeAPI::Message::Conversation::PhoneNumber::Type }
 
-          # @!method initialize(id:, name:, number:, type:)
+          # @!method initialize(id:, metadata:, name:, number:, type:)
           #   This is the phone number tied to the Surge account.
           #
           #   @param id [String] Unique identifier for the phone number
           #
+          #   @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 canonical format of the phone number.

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -62,6 +62,12 @@ module SurgeAPI
         #   @return [Time]
         required :delivered_at, Time
 
+        # @!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.
         #
@@ -88,7 +94,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, delivered_at:, metadata:, status:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, delivered_at:, failure_reason:, metadata:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageDeliveredWebhookEvent::Data} for more details.
         #
@@ -102,6 +108,8 @@ module SurgeAPI
         #
         #   @param delivered_at [Time] When the message was delivered
         #
+        #   @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 status [Symbol, SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Status] The message status represented by this event

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -63,10 +63,11 @@ module SurgeAPI
         required :failed_at, Time
 
         # @!attribute failure_reason
-        #   The reason the message failed to be delivered
+        #   The reason the message failed to be delivered, or null if no failure reason is
+        #   set
         #
-        #   @return [String]
-        required :failure_reason, String
+        #   @return [String, nil]
+        required :failure_reason, String, nil?: true
 
         # @!attribute metadata
         #   Set of key-value pairs that will be stored with the object.
@@ -108,7 +109,7 @@ module SurgeAPI
         #
         #   @param failed_at [Time] When the message failed
         #
-        #   @param failure_reason [String] The reason the message failed to be delivered
+        #   @param failure_reason [String, nil] The reason the message failed to be delivered, or null if no failure reason is s
         #
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -56,6 +56,12 @@ module SurgeAPI
         #   @return [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation]
         required :conversation, -> { SurgeAPI::MessageReceivedWebhookEvent::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.
         #
@@ -88,7 +94,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, metadata:, received_at:, status:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, failure_reason:, metadata:, received_at:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageReceivedWebhookEvent::Data} for more details.
         #
@@ -100,6 +106,8 @@ module SurgeAPI
         #
         #   @param conversation [SurgeAPI::Models::MessageReceivedWebhookEvent::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 received_at [Time] When the message was received

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.
         #
@@ -88,7 +94,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, metadata:, sent_at:, status:, 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.
         #
@@ -100,6 +106,8 @@ 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

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

@@ -59,6 +59,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
         #
@@ -77,7 +83,7 @@ module SurgeAPI
         #   @return [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Type]
         required :type, enum: -> { SurgeAPI::PhoneNumberImportedWebhookEvent::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::PhoneNumberImportedWebhookEvent::Data} for more details.
         #
@@ -89,6 +95,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_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}]