surge_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71252990f4c5eb46dec5222b3dd1307f1c347b59ef3a2c7a1aa6ac646555c920
-  data.tar.gz: 671de5440b15ba3455652ffcf8b8f0752c6e4827750a99dcb288bfa26cf65acd
+  metadata.gz: cc8267ebb4682d2884a0ed0a4ff0c1ec89a6e76988ee96cbdd794bc9ee745ef2
+  data.tar.gz: fcefd6289c6dae43967d4eac94bbc87299ab03c52e335f611949a4d6169c7c79
 SHA512:
-  metadata.gz: 4595e79a8c3fccbdf83430c0242b378b70acb7f52471a5177e9b78542889f310c62c8d5a6d41515a8cfd6ef72df9a298428274645b0b38f8f61eeb42ea0a3c57
-  data.tar.gz: 538a4232414a89f66dd781f0bda3a4e8257cdf9a88d7a07d3efef95345a26a93f895d696b54a6ff3c987f29fac2d62abda9e9c44532786d2e145d8b24c3da6b7
+  metadata.gz: 22b712d8f2898bca0a102de847125c57cc1feb4771c23db55de558616b6dba9de87a1915e05e44c23ca619872f9a9d0f70df9c8f522e8f867048fd43a53cb660
+  data.tar.gz: '025923bb1e6f82ecbe04e30ee9f849369e8ddd76dd73f729dfe046220ffc044633cc7f1d15d286b6d37c2b5d6d641bae27e2cb558499e4c6271133997ba8444f'

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 0.2.1 (2025-10-31)
+
+Full Changelog: [v0.2.0...v0.2.1](https://github.com/surgeapi/ruby-sdk/compare/v0.2.0...v0.2.1)
+
+### Features
+
+* **api:** create externally registered campaigns ([c01b26e](https://github.com/surgeapi/ruby-sdk/commit/c01b26e3f26a8b827254d128a7c776d79850cbf5))
+* handle thread interrupts in the core HTTP client ([4362499](https://github.com/surgeapi/ruby-sdk/commit/43624993a62c67679d1f5260653517aebd5d687e))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([58fa7be](https://github.com/surgeapi/ruby-sdk/commit/58fa7bea703edecd59fe69630191a9cb83ece9d0))
+* should not reuse buffers for `IO.copy_stream` interop ([52ce0fd](https://github.com/surgeapi/ruby-sdk/commit/52ce0fd6a7039be032e2f884636215ac1fb88223))
+
+
+### Documentation
+
+* **api:** add context around organization contacts ([88c764d](https://github.com/surgeapi/ruby-sdk/commit/88c764d18d70361d1a7f43e22a46d26082f24227))
+
 ## 0.2.0 (2025-10-09)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/surgeapi/ruby-sdk/compare/v0.1.0...v0.2.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.2.0"
+gem "surge_api", "~> 0.2.1"
 ```
 
 <!-- x-release-please-end -->
@@ -32,12 +32,7 @@ surge = SurgeAPI::Client.new(
   api_key: ENV["SURGE_API_KEY"] # This is the default and can be omitted
 )
 
-message = surge.messages.create(
-  "acct_01j9a43avnfqzbjfch6pygv1td",
-  conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-  attachments: [{url: "https://toretto.family/coronas.gif"}],
-  body: "Thought you could leave without saying goodbye?"
-)
+message = surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
 
 puts(message.id)
 ```
@@ -48,12 +43,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  message = surge.messages.create(
-    "acct_01j9a43avnfqzbjfch6pygv1td",
-    conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-    attachments: [{url: "https://toretto.family/coronas.gif"}],
-    body: "Thought you could leave without saying goodbye?"
-  )
+  message = surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
 rescue SurgeAPI::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -96,13 +86,7 @@ surge = SurgeAPI::Client.new(
 )
 
 # Or, configure per-request:
-surge.messages.create(
-  "acct_01j9a43avnfqzbjfch6pygv1td",
-  conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-  attachments: [{url: "https://toretto.family/coronas.gif"}],
-  body: "Thought you could leave without saying goodbye?",
-  request_options: {max_retries: 5}
-)
+surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -116,13 +100,7 @@ surge = SurgeAPI::Client.new(
 )
 
 # Or, configure per-request:
-surge.messages.create(
-  "acct_01j9a43avnfqzbjfch6pygv1td",
-  conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-  attachments: [{url: "https://toretto.family/coronas.gif"}],
-  body: "Thought you could leave without saying goodbye?",
-  request_options: {timeout: 5}
-)
+surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", request_options: {timeout: 5})
 ```
 
 On timeout, `SurgeAPI::Errors::APITimeoutError` is raised.
@@ -155,9 +133,6 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 message =
   surge.messages.create(
     "acct_01j9a43avnfqzbjfch6pygv1td",
-    conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-    attachments: [{url: "https://toretto.family/coronas.gif"}],
-    body: "Thought you could leave without saying goodbye?",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -203,43 +178,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-surge.messages.create(
-  "acct_01j9a43avnfqzbjfch6pygv1td",
-  conversation: SurgeAPI::MessageCreateParams::Conversation.new(
-    contact: SurgeAPI::MessageCreateParams::Conversation::Contact.new(
-      first_name: "Dom",
-      last_name: "Toretto",
-      phone_number: "+13235556439"
-    )
-  ),
-  attachments: [SurgeAPI::MessageCreateParams::Attachment.new(url: "https://toretto.family/coronas.gif")],
-  body: "Thought you could leave without saying goodbye?"
-)
+surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-surge.messages.create(
-  "acct_01j9a43avnfqzbjfch6pygv1td",
-  conversation: {contact: {first_name: "Dom", last_name: "Toretto", phone_number: "+13235556439"}},
-  attachments: [{url: "https://toretto.family/coronas.gif"}],
-  body: "Thought you could leave without saying goodbye?"
-)
+surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
 
 # You can also splat a full Params class:
-params = SurgeAPI::MessageCreateParams.new(
-  conversation: SurgeAPI::MessageCreateParams::Conversation.new(
-    contact: SurgeAPI::MessageCreateParams::Conversation::Contact.new(
-      first_name: "Dom",
-      last_name: "Toretto",
-      phone_number: "+13235556439"
-    )
-  ),
-  attachments: [SurgeAPI::MessageCreateParams::Attachment.new(url: "https://toretto.family/coronas.gif")],
-  body: "Thought you could leave without saying goodbye?"
-)
+params = SurgeAPI::MessageCreateParams.new
 surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", **params)
 ```
 
@@ -249,10 +198,10 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E
 
 ```ruby
 # :high
-puts(SurgeAPI::CampaignCreateParams::Volume::HIGH)
+puts(SurgeAPI::CampaignParams::Volume::HIGH)
 
-# Revealed type: `T.all(SurgeAPI::CampaignCreateParams::Volume, Symbol)`
-T.reveal_type(SurgeAPI::CampaignCreateParams::Volume::HIGH)
+# Revealed type: `T.all(SurgeAPI::CampaignParams::Volume, Symbol)`
+T.reveal_type(SurgeAPI::CampaignParams::Volume::HIGH)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
@@ -260,7 +209,7 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants
 ```ruby
 # Using the enum constants preserves the tagged type information:
 surge.campaigns.create(
-  volume: SurgeAPI::CampaignCreateParams::Volume::HIGH,
+  volume: SurgeAPI::CampaignParams::Volume::HIGH,
   # …
 )
 

data/lib/surge_api/internal/transport/pooled_net_requester.rb

@@ -128,40 +128,48 @@ module SurgeAPI
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
             next if finished
 
             with_pool(url, deadline: deadline) do |conn|
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [req, rsp]
-                break if finished
-
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
+                  conn.request(req) do |rsp|
+                    y << [req, rsp]
+                    break if finished
+
+                    rsp.read_body do |bytes|
+                      y << bytes.force_encoding(Encoding::BINARY)
+                      break if finished
+
+                      self.class.calibrate_socket_timeout(conn, deadline)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
-            ensure
-              conn.finish if !eof && conn&.started?
             end
           rescue Timeout::Error
             raise SurgeAPI::Errors::APITimeoutError.new(url: url, request: req)
@@ -174,8 +182,6 @@ module SurgeAPI
           body = SurgeAPI::Internal::Util.fused_enum(enum, external: true) do
             finished = true
             loop { enum.next }
-          ensure
-            closing&.call
           end
           [Integer(response.code), response, body]
         end

data/lib/surge_api/internal/util.rb

@@ -346,8 +346,9 @@ module SurgeAPI
           base_path, base_query = lhs.fetch_values(:path, :query)
           slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
 
-          parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
-          override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
+          merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
+          parsed_path, parsed_query = merged.fetch_values(:path, :query)
+          override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
           query = deep_merge(
@@ -473,10 +474,9 @@ module SurgeAPI
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new
             y.define_singleton_method(:write) do
-              self << buf.replace(_1)
-              buf.bytesize
+              self << _1.dup
+              _1.bytesize
             end
 
             blk.call(y)

data/lib/surge_api/models/account_create_params.rb

@@ -60,8 +60,11 @@ module SurgeAPI
         optional :address, -> { SurgeAPI::AccountCreateParams::Organization::Address }
 
         # @!attribute contact
-        #   An object representing an individual who can be contacted if the carriers have
-        #   any questions about the business.
+        #   An object representing an individual who can be contacted if Surge or our
+        #   carrier partners have any questions about the business. If you are registering
+        #   on behalf of your customer, this must be a contact from your customer's company
+        #   rather than your own. The individual will likely never be contacted unless there
+        #   are issues with spam.
         #
         #   @return [SurgeAPI::Models::AccountCreateParams::Organization::Contact, nil]
         optional :contact, -> { SurgeAPI::AccountCreateParams::Organization::Contact }, nil?: true
@@ -169,7 +172,7 @@ module SurgeAPI
         #
         #   @param address [SurgeAPI::Models::AccountCreateParams::Organization::Address] The address of the organization's headquarters.
         #
-        #   @param contact [SurgeAPI::Models::AccountCreateParams::Organization::Contact, nil] An object representing an individual who can be contacted if the carriers have a
+        #   @param contact [SurgeAPI::Models::AccountCreateParams::Organization::Contact, nil] An object representing an individual who can be contacted if Surge or our carrie
         #
         #   @param country [String, nil] The two character ISO 3166 country code for the country in which the organizatio
         #
@@ -269,7 +272,8 @@ module SurgeAPI
           #   using the same domain name as the website URL will be preferred (e.g. with a
           #   website domain of `https://dtprecisionauto.com`, an email like
           #   `dom@dtprecisionauto.com` will be preferred over one like
-          #   `dom@anothergarage.com` or `dom.toretto@gmail.com`)
+          #   `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
+          #   would also be acceptable, but not preferred)
           #
           #   @return [String, nil]
           optional :email, String, nil?: true
@@ -313,8 +317,11 @@ module SurgeAPI
           #   Some parameter documentations has been truncated, see
           #   {SurgeAPI::Models::AccountCreateParams::Organization::Contact} for more details.
           #
-          #   An object representing an individual who can be contacted if the carriers have
-          #   any questions about the business.
+          #   An object representing an individual who can be contacted if Surge or our
+          #   carrier partners have any questions about the business. If you are registering
+          #   on behalf of your customer, this must be a contact from your customer's company
+          #   rather than your own. The individual will likely never be contacted unless there
+          #   are issues with spam.
           #
           #   @param email [String, nil] An email address at which the individual can be reached. Typically an email usin
           #

data/lib/surge_api/models/account_update_params.rb

@@ -59,8 +59,11 @@ module SurgeAPI
         optional :address, -> { SurgeAPI::AccountUpdateParams::Organization::Address }
 
         # @!attribute contact
-        #   An object representing an individual who can be contacted if the carriers have
-        #   any questions about the business.
+        #   An object representing an individual who can be contacted if Surge or our
+        #   carrier partners have any questions about the business. If you are registering
+        #   on behalf of your customer, this must be a contact from your customer's company
+        #   rather than your own. The individual will likely never be contacted unless there
+        #   are issues with spam.
         #
         #   @return [SurgeAPI::Models::AccountUpdateParams::Organization::Contact, nil]
         optional :contact, -> { SurgeAPI::AccountUpdateParams::Organization::Contact }, nil?: true
@@ -168,7 +171,7 @@ module SurgeAPI
         #
         #   @param address [SurgeAPI::Models::AccountUpdateParams::Organization::Address] The address of the organization's headquarters.
         #
-        #   @param contact [SurgeAPI::Models::AccountUpdateParams::Organization::Contact, nil] An object representing an individual who can be contacted if the carriers have a
+        #   @param contact [SurgeAPI::Models::AccountUpdateParams::Organization::Contact, nil] An object representing an individual who can be contacted if Surge or our carrie
         #
         #   @param country [String, nil] The two character ISO 3166 country code for the country in which the organizatio
         #
@@ -268,7 +271,8 @@ module SurgeAPI
           #   using the same domain name as the website URL will be preferred (e.g. with a
           #   website domain of `https://dtprecisionauto.com`, an email like
           #   `dom@dtprecisionauto.com` will be preferred over one like
-          #   `dom@anothergarage.com` or `dom.toretto@gmail.com`)
+          #   `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
+          #   would also be acceptable, but not preferred)
           #
           #   @return [String, nil]
           optional :email, String, nil?: true
@@ -312,8 +316,11 @@ module SurgeAPI
           #   Some parameter documentations has been truncated, see
           #   {SurgeAPI::Models::AccountUpdateParams::Organization::Contact} for more details.
           #
-          #   An object representing an individual who can be contacted if the carriers have
-          #   any questions about the business.
+          #   An object representing an individual who can be contacted if Surge or our
+          #   carrier partners have any questions about the business. If you are registering
+          #   on behalf of your customer, this must be a contact from your customer's company
+          #   rather than your own. The individual will likely never be contacted unless there
+          #   are issues with spam.
           #
           #   @param email [String, nil] An email address at which the individual can be reached. Typically an email usin
           #

data/lib/surge_api/models/campaign_create_params.rb

@@ -7,196 +7,20 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!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.
+      # @!attribute campaign_params
+      #   Parameters for creating a new campaign. Either provide full campaign details or
+      #   import using a TCR ID.
       #
-      #   @return [String]
-      required :consent_flow, String
+      #   @return [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams]
+      required :campaign_params, union: -> { SurgeAPI::CampaignParams }
 
-      # @!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::CampaignCreateParams::UseCase>]
-      required :use_cases,
-               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignCreateParams::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::CampaignCreateParams::Volume]
-      required :volume, enum: -> { SurgeAPI::CampaignCreateParams::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::CampaignCreateParams::Include>, nil]
-      optional :includes,
-               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignCreateParams::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, request_options: {})
+      # @!method initialize(campaign_params:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::CampaignCreateParams} for more details.
       #
-      #   @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::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
-
-      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.
-      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
   end
 end