surge_api 0.2.0 → 0.2.1

data/lib/surge_api/models/campaign_params.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # Parameters for creating a new campaign. Either provide full campaign details or
+    # import using a TCR ID.
+    module CampaignParams
+      extend SurgeAPI::Internal::Type::Union
+
+      # Full campaign details for standard registration through Surge
+      variant -> { SurgeAPI::CampaignParams::StandardCampaignParams }
+
+      # Import an externally registered campaign from The Campaign Registry (TCR)
+      variant -> { SurgeAPI::CampaignParams::ExternalCampaignParams }
+
+      class StandardCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        # @!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]
+        required :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]
+        required :description, String
+
+        # @!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>]
+        required :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]
+        required :privacy_policy_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::CampaignParams::StandardCampaignParams::UseCase>]
+        required :use_cases,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignParams::StandardCampaignParams::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 platform 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 platform 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::CampaignParams::StandardCampaignParams::Volume]
+        required :volume, enum: -> { SurgeAPI::CampaignParams::StandardCampaignParams::Volume }
+
+        # @!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::CampaignParams::StandardCampaignParams::Include>, nil]
+        optional :includes,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignParams::StandardCampaignParams::Include] }
+
+        # @!attribute link_sample
+        #   A sample link that might be sent by this campaign. If links from other domains
+        #   are sent through this campaign, they are much more likely to be filtered by the
+        #   carriers. If link shortening is enabled for the account, the link shortener URL
+        #   will be used instead of what is provided. Reach out to support if you would like
+        #   to disable automatic link shortening.
+        #
+        #   @return [String, nil]
+        optional :link_sample, 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
+
+        # @!method initialize(consent_flow:, description:, message_samples:, privacy_policy_url:, use_cases:, volume:, includes: nil, link_sample: nil, terms_and_conditions_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::CampaignParams::StandardCampaignParams} for more details.
+        #
+        #   Full campaign details for standard registration through Surge
+        #
+        #   @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 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 use_cases [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+        #
+        #   @param volume [Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Volume] This will be one of the following:
+        #
+        #   @param includes [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Include>] A list of properties that this campaign should include. These properties can be
+        #
+        #   @param link_sample [String] A sample link that might be sent by this campaign. If links from other domains a
+        #
+        #   @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+
+        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 platform 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 platform 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.
+        #
+        # @see SurgeAPI::Models::CampaignParams::StandardCampaignParams#volume
+        module Volume
+          extend SurgeAPI::Internal::Type::Enum
+
+          HIGH = :high
+          LOW = :low
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        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
+      end
+
+      class ExternalCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute tcr_id
+        #   The Campaign Registry (TCR) ID for the externally registered campaign
+        #
+        #   @return [String]
+        required :tcr_id, String
+
+        # @!method initialize(tcr_id:)
+        #   Import an externally registered campaign from The Campaign Registry (TCR)
+        #
+        #   @param tcr_id [String] The Campaign Registry (TCR) ID for the externally registered campaign
+      end
+
+      # @!method self.variants
+      #   @return [Array(SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams)]
+    end
+  end
+end

data/lib/surge_api/models/message_create_params.rb

@@ -7,147 +7,21 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!attribute conversation
-      #   Params for selecting or creating a new conversation. Either the id or the
-      #   Contact must be given.
+      # @!attribute message_params
+      #   Payload for creating a message. Either an attachment or the body must be given.
+      #   You can specify the recipient either using the 'conversation' parameter or the
+      #   'to'/'from' parameters, but not both.
       #
-      #   @return [SurgeAPI::Models::MessageCreateParams::Conversation]
-      required :conversation, -> { SurgeAPI::MessageCreateParams::Conversation }
+      #   @return [SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams]
+      required :message_params, union: -> { SurgeAPI::MessageParams }
 
-      # @!attribute attachments
-      #
-      #   @return [Array<SurgeAPI::Models::MessageCreateParams::Attachment>, nil]
-      optional :attachments, -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageCreateParams::Attachment] }
-
-      # @!attribute body
-      #   The message body.
-      #
-      #   @return [String, nil]
-      optional :body, String
-
-      # @!attribute send_at
-      #   An optional datetime for scheduling message up to a couple of months in the
-      #   future.
-      #
-      #   @return [Time, nil]
-      optional :send_at, Time
-
-      # @!attribute to
-      #   The recipient's phone number in E.164 format. Cannot be used together with
-      #   'conversation'.
-      #
-      #   @return [String]
-      required :to, String
-
-      # @!attribute from
-      #   The sender's phone number in E.164 format or phone number ID. If omitted, uses
-      #   the account's default phone number. Cannot be used together with 'conversation'.
-      #
-      #   @return [String, nil]
-      optional :from, String
-
-      # @!method initialize(conversation:, to:, attachments: nil, body: nil, send_at: nil, from: nil, request_options: {})
+      # @!method initialize(message_params:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::MessageCreateParams} for more details.
       #
-      #   @param conversation [SurgeAPI::Models::MessageCreateParams::Conversation] Params for selecting or creating a new conversation. Either the id or the Contac
-      #
-      #   @param to [String] The recipient's phone number in E.164 format. Cannot be used together with 'conv
-      #
-      #   @param attachments [Array<SurgeAPI::Models::MessageCreateParams::Attachment>]
-      #
-      #   @param body [String] The message body.
-      #
-      #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
-      #
-      #   @param from [String] The sender's phone number in E.164 format or phone number ID. If omitted, uses t
+      #   @param message_params [SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams] Payload for creating a message. Either an attachment or the body must be given.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
-
-      class Conversation < SurgeAPI::Internal::Type::BaseModel
-        # @!attribute contact
-        #   Parameters for creating a contact
-        #
-        #   @return [SurgeAPI::Models::MessageCreateParams::Conversation::Contact]
-        required :contact, -> { SurgeAPI::MessageCreateParams::Conversation::Contact }
-
-        # @!attribute phone_number
-        #   The phone number from which to send the message. This can be either the phone
-        #   number in E.164 format or a Surge phone number id.
-        #
-        #   @return [String, nil]
-        optional :phone_number, String
-
-        # @!method initialize(contact:, phone_number: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {SurgeAPI::Models::MessageCreateParams::Conversation} for more details.
-        #
-        #   Params for selecting or creating a new conversation. Either the id or the
-        #   Contact must be given.
-        #
-        #   @param contact [SurgeAPI::Models::MessageCreateParams::Conversation::Contact] Parameters for creating a contact
-        #
-        #   @param phone_number [String] The phone number from which to send the message. This can be either the phone nu
-
-        # @see SurgeAPI::Models::MessageCreateParams::Conversation#contact
-        class Contact < SurgeAPI::Internal::Type::BaseModel
-          # @!attribute phone_number
-          #   The contact's phone number in E.164 format.
-          #
-          #   @return [String]
-          required :phone_number, String
-
-          # @!attribute email
-          #   The contact's email address.
-          #
-          #   @return [String, nil]
-          optional :email, String
-
-          # @!attribute first_name
-          #   The contact's first name.
-          #
-          #   @return [String, nil]
-          optional :first_name, String
-
-          # @!attribute last_name
-          #   The contact's last name.
-          #
-          #   @return [String, nil]
-          optional :last_name, 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]
-
-          # @!method initialize(phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil)
-          #   Parameters for creating a contact
-          #
-          #   @param phone_number [String] The contact's phone number in E.164 format.
-          #
-          #   @param email [String] The contact's email address.
-          #
-          #   @param first_name [String] The contact's first name.
-          #
-          #   @param last_name [String] The contact's last name.
-          #
-          #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
-        end
-      end
-
-      class Attachment < SurgeAPI::Internal::Type::BaseModel
-        # @!attribute url
-        #   The URL of the attachment.
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!method initialize(url:)
-        #   Params for creating an attachment
-        #
-        #   @param url [String] The URL of the attachment.
-      end
     end
   end
 end

data/lib/surge_api/models/message_params.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # Payload for creating a message. Either an attachment or the body must be given.
+    # You can specify the recipient either using the 'conversation' parameter or the
+    # 'to'/'from' parameters, but not both.
+    module MessageParams
+      extend SurgeAPI::Internal::Type::Union
+
+      # Create a message while including parameters for the conversation in which the message should be sent.
+      variant -> { SurgeAPI::MessageParams::MessageParamsWithConversation }
+
+      # Create a basic message by specifying just the to/from phone numbers.
+      variant -> { SurgeAPI::MessageParams::SimpleMessageParams }
+
+      class MessageParamsWithConversation < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute conversation
+        #   Params for selecting or creating a new conversation. Either the id or the
+        #   Contact must be given.
+        #
+        #   @return [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation]
+        required :conversation, -> { SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation }
+
+        # @!attribute attachments
+        #
+        #   @return [Array<SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment] }
+
+        # @!attribute body
+        #   The message body.
+        #
+        #   @return [String, nil]
+        optional :body, String
+
+        # @!attribute send_at
+        #   An optional datetime for scheduling message up to a couple of months in the
+        #   future.
+        #
+        #   @return [Time, nil]
+        optional :send_at, Time
+
+        # @!method initialize(conversation:, attachments: nil, body: nil, send_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageParams::MessageParamsWithConversation} for more
+        #   details.
+        #
+        #   Create a message while including parameters for the conversation in which the
+        #   message should be sent.
+        #
+        #   @param conversation [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation] Params for selecting or creating a new conversation. Either the id or the Contac
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Attachment>]
+        #
+        #   @param body [String] The message body.
+        #
+        #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
+
+        # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation#conversation
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute contact
+          #   Parameters for creating a contact
+          #
+          #   @return [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation::Contact]
+          required :contact, -> { SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact }
+
+          # @!attribute phone_number
+          #   The phone number from which to send the message. This can be either the phone
+          #   number in E.164 format or a Surge phone number id.
+          #
+          #   @return [String, nil]
+          optional :phone_number, String
+
+          # @!method initialize(contact:, phone_number: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation}
+          #   for more details.
+          #
+          #   Params for selecting or creating a new conversation. Either the id or the
+          #   Contact must be given.
+          #
+          #   @param contact [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation::Contact] Parameters for creating a contact
+          #
+          #   @param phone_number [String] The phone number from which to send the message. This can be either the phone nu
+
+          # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Conversation#contact
+          class Contact < SurgeAPI::Internal::Type::BaseModel
+            # @!attribute phone_number
+            #   The contact's phone number in E.164 format.
+            #
+            #   @return [String]
+            required :phone_number, String
+
+            # @!attribute email
+            #   The contact's email address.
+            #
+            #   @return [String, nil]
+            optional :email, String
+
+            # @!attribute first_name
+            #   The contact's first name.
+            #
+            #   @return [String, nil]
+            optional :first_name, String
+
+            # @!attribute last_name
+            #   The contact's last name.
+            #
+            #   @return [String, nil]
+            optional :last_name, 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]
+
+            # @!method initialize(phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil)
+            #   Parameters for creating a contact
+            #
+            #   @param phone_number [String] The contact's phone number in E.164 format.
+            #
+            #   @param email [String] The contact's email address.
+            #
+            #   @param first_name [String] The contact's first name.
+            #
+            #   @param last_name [String] The contact's last name.
+            #
+            #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+          end
+        end
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute url
+          #   The URL of the attachment.
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(url:)
+          #   Params for creating an attachment
+          #
+          #   @param url [String] The URL of the attachment.
+        end
+      end
+
+      class SimpleMessageParams < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute to
+        #   The recipient's phone number in E.164 format. Cannot be used together with
+        #   'conversation'.
+        #
+        #   @return [String]
+        required :to, String
+
+        # @!attribute attachments
+        #
+        #   @return [Array<SurgeAPI::Models::MessageParams::SimpleMessageParams::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageParams::SimpleMessageParams::Attachment] }
+
+        # @!attribute body
+        #   The message body.
+        #
+        #   @return [String, nil]
+        optional :body, String
+
+        # @!attribute from
+        #   The sender's phone number in E.164 format or phone number ID. If omitted, uses
+        #   the account's default phone number. Cannot be used together with 'conversation'.
+        #
+        #   @return [String, nil]
+        optional :from, String
+
+        # @!attribute send_at
+        #   An optional datetime for scheduling message up to a couple of months in the
+        #   future.
+        #
+        #   @return [Time, nil]
+        optional :send_at, Time
+
+        # @!method initialize(to:, attachments: nil, body: nil, from: nil, send_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageParams::SimpleMessageParams} for more details.
+        #
+        #   Create a basic message by specifying just the to/from phone numbers.
+        #
+        #   @param to [String] The recipient's phone number in E.164 format. Cannot be used together with 'conv
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageParams::SimpleMessageParams::Attachment>]
+        #
+        #   @param body [String] The message body.
+        #
+        #   @param from [String] The sender's phone number in E.164 format or phone number ID. If omitted, uses t
+        #
+        #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute url
+          #   The URL of the attachment.
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(url:)
+          #   Params for creating an attachment
+          #
+          #   @param url [String] The URL of the attachment.
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams)]
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -61,6 +61,8 @@ module SurgeAPI
 
   CampaignCreateParams = SurgeAPI::Models::CampaignCreateParams
 
+  CampaignParams = SurgeAPI::Models::CampaignParams
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
@@ -85,6 +87,8 @@ module SurgeAPI
 
   MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
 
+  MessageParams = SurgeAPI::Models::MessageParams
+
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
 
   MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent

data/lib/surge_api/resources/campaigns.rb

@@ -8,27 +8,11 @@ module SurgeAPI
       #
       # Creates a campaign to register account to send text messages.
       #
-      # @overload create(account_id, consent_flow:, description:, message_samples:, privacy_policy_url:, use_cases:, volume:, includes: nil, link_sample: nil, terms_and_conditions_url: nil, request_options: {})
+      # @overload create(account_id, campaign_params:, request_options: {})
       #
       # @param account_id [String] The account for which the campaign should be created.
       #
-      # @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 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 use_cases [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
-      #
-      # @param volume [Symbol, SurgeAPI::Models::CampaignCreateParams::Volume] This will be one of the following:
-      #
-      # @param includes [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::Include>] A list of properties that this campaign should include. These properties can be
-      #
-      # @param link_sample [String] A sample link that might be sent by this campaign. If links from other domains a
-      #
-      # @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+      # @param campaign_params [SurgeAPI::CampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -37,6 +21,11 @@ module SurgeAPI
       # @see SurgeAPI::Models::CampaignCreateParams
       def create(account_id, params)
         parsed, options = SurgeAPI::CampaignCreateParams.dump_request(params)
+        case parsed
+        in {campaign_params: Hash => union, **rest}
+          parsed = {**rest, **union}
+        else
+        end
         @client.request(
           method: :post,
           path: ["accounts/%1$s/campaigns", account_id],