surge_api 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcd65a3f11b5c187dcefe5f82f90dfef4bb4421e06115246ccda187f459e9202
-  data.tar.gz: c8bac9291bc751a4ddfdb952f70eb32fcb696ef886a5c3521f149e7235f18733
+  metadata.gz: d65004cf163c9724f560bd9541e0f55ceabd3d516e6938d318f7ab17302d0880
+  data.tar.gz: d80c1e25b422f575977b4f8a073640aae972e50492e7b1430b3c7835193c22a6
 SHA512:
-  metadata.gz: '0032493ed7b14b18fc06f216c37ed91814fbd61874e777604013cde0c694859767b177820dc298559024a9a2c7f39d878157e7e6b24035fce20ad07fa1b984e0'
-  data.tar.gz: abe1e0ff490003f4f4376847989c4b0f982abb34ac3eae1bc308b81abf22a03e4078dd08d49c23db58a91e271831d450fe2087938286455fcc381d126602a14c
+  metadata.gz: be50b1c68afb192da466f0bc4bc3d17f2c413ecdcbee12aab3fa7ea5f60b0346098dea593c83bee5802ac7806db14c7f3e0d726237414445c3bcb1989cc89930
+  data.tar.gz: 0c9ff556f313c28bff2152bf9670846441f797cfd81476bde254983534e4bead99b06eec575455ea89e2daf32903d39bdeee679eed0c142051d6877719fd2053

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.18.0 (2026-06-30)
+
+Full Changelog: [v0.17.0...v0.18.0](https://github.com/surgeapi/ruby-sdk/compare/v0.17.0...v0.18.0)
+
+### Features
+
+* **api:** add contact to attachment types ([2deb16b](https://github.com/surgeapi/ruby-sdk/commit/2deb16b7a54e656be02438844c68de41dcdc0aff))
+* **api:** add message settings ([a0b6be6](https://github.com/surgeapi/ruby-sdk/commit/a0b6be6586d6392a9a01143c3e838618246e0183))
+* **api:** add update phone number endpoint ([1953448](https://github.com/surgeapi/ruby-sdk/commit/1953448bc582187a06e9a474fd7587510868d389))
+* **api:** remove extraneous empty properties ([230dd27](https://github.com/surgeapi/ruby-sdk/commit/230dd27965e2d6ac14920a584baefe9067a702c1))
+
+
+### Bug Fixes
+
+* **client:** send content-type header for requests with an omitted optional body ([b482a41](https://github.com/surgeapi/ruby-sdk/commit/b482a41647474442749c52b692083119985c5d39))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([85fcacc](https://github.com/surgeapi/ruby-sdk/commit/85fcaccabe7f4f1321306a5edd86a63eb2c50322))
+* **spec:** remove extraneous empty properties ([e985a21](https://github.com/surgeapi/ruby-sdk/commit/e985a21b5b45e835fe2a623c3cc38030fee2455d))
+
 ## 0.17.0 (2026-05-04)
 
 Full Changelog: [v0.16.0...v0.17.0](https://github.com/surgeapi/ruby-sdk/compare/v0.16.0...v0.17.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.17.0"
+gem "surge_api", "~> 0.18.0"
 ```
 
 <!-- x-release-please-end -->
@@ -32,7 +32,10 @@ surge = SurgeAPI::Client.new(
   api_key: ENV["SURGE_API_KEY"] # This is the default and can be omitted
 )
 
-message = surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
+message = surge.messages.create(
+  "acct_01j9a43avnfqzbjfch6pygv1td",
+  message_params: {conversation: {contact: {phone_number: "+18015551234"}}}
+)
 
 puts(message.id)
 ```
@@ -71,7 +74,10 @@ 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")
+  message = surge.messages.create(
+    "acct_01j9a43avnfqzbjfch6pygv1td",
+    message_params: {conversation: {contact: {phone_number: "+18015551234"}}}
+  )
 rescue SurgeAPI::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -114,7 +120,11 @@ surge = SurgeAPI::Client.new(
 )
 
 # Or, configure per-request:
-surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", request_options: {max_retries: 5})
+surge.messages.create(
+  "acct_01j9a43avnfqzbjfch6pygv1td",
+  message_params: {conversation: {contact: {phone_number: "+18015551234"}}},
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -128,7 +138,11 @@ surge = SurgeAPI::Client.new(
 )
 
 # Or, configure per-request:
-surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", request_options: {timeout: 5})
+surge.messages.create(
+  "acct_01j9a43avnfqzbjfch6pygv1td",
+  message_params: {conversation: {contact: {phone_number: "+18015551234"}}},
+  request_options: {timeout: 5}
+)
 ```
 
 On timeout, `SurgeAPI::Errors::APITimeoutError` is raised.
@@ -161,6 +175,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 message =
   surge.messages.create(
     "acct_01j9a43avnfqzbjfch6pygv1td",
+    message_params: {conversation: {contact: {phone_number: "+18015551234"}}},
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -206,17 +221,37 @@ 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")
+surge.messages.create(
+  "acct_01j9a43avnfqzbjfch6pygv1td",
+  message_params: SurgeAPI::MessageParams::MessageParamsWithConversation.new(
+    conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation.new(
+      contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact.new(
+        phone_number: "+18015551234"
+      )
+    )
+  )
+)
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
+surge.messages.create(
+  "acct_01j9a43avnfqzbjfch6pygv1td",
+  message_params: {conversation: {contact: {phone_number: "+18015551234"}}}
+)
 
 # You can also splat a full Params class:
-params = SurgeAPI::MessageCreateParams.new
+params = SurgeAPI::MessageCreateParams.new(
+  message_params: SurgeAPI::MessageParams::MessageParamsWithConversation.new(
+    conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation.new(
+      contact: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation::Contact.new(
+        phone_number: "+18015551234"
+      )
+    )
+  )
+)
 surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", **params)
 ```
 
@@ -225,25 +260,25 @@ surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td", **params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :high
-puts(SurgeAPI::CampaignParams::Volume::HIGH)
+# :local
+puts(SurgeAPI::PhoneNumberPurchaseParams::Type::LOCAL)
 
-# Revealed type: `T.all(SurgeAPI::CampaignParams::Volume, Symbol)`
-T.reveal_type(SurgeAPI::CampaignParams::Volume::HIGH)
+# Revealed type: `T.all(SurgeAPI::PhoneNumberPurchaseParams::Type, Symbol)`
+T.reveal_type(SurgeAPI::PhoneNumberPurchaseParams::Type::LOCAL)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-surge.campaigns.create(
-  volume: SurgeAPI::CampaignParams::Volume::HIGH,
+surge.phone_numbers.purchase(
+  type: SurgeAPI::PhoneNumberPurchaseParams::Type::LOCAL,
   # …
 )
 
 # Literal values are also permissible:
-surge.campaigns.create(
-  volume: :high,
+surge.phone_numbers.purchase(
+  type: :local,
   # …
 )
 ```

data/lib/surge_api/client.rb

@@ -18,6 +18,9 @@ module SurgeAPI
     # @return [String]
     attr_reader :api_key
 
+    # @return [String, nil]
+    attr_reader :webhook_signing_secret
+
     # @return [SurgeAPI::Resources::Accounts]
     attr_reader :accounts
 
@@ -67,6 +70,8 @@ module SurgeAPI
     #
     # @param api_key [String, nil] Defaults to `ENV["SURGE_API_KEY"]`
     #
+    # @param webhook_signing_secret [String, nil] Defaults to `ENV["SURGE_WEBHOOK_SIGNING_SECRET"]`
+    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["SURGE_BASE_URL"]`
     #
@@ -79,6 +84,7 @@ module SurgeAPI
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["SURGE_API_KEY"],
+      webhook_signing_secret: ENV["SURGE_WEBHOOK_SIGNING_SECRET"],
       base_url: ENV["SURGE_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -91,14 +97,29 @@ module SurgeAPI
         raise ArgumentError.new("api_key is required, and can be set via environ: \"SURGE_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["SURGE_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
+      @webhook_signing_secret = webhook_signing_secret&.to_s
 
       super(
         base_url: base_url,
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @accounts = SurgeAPI::Resources::Accounts.new(client: self)

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

@@ -306,6 +306,11 @@ module SurgeAPI
               SurgeAPI::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = SurgeAPI::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/surge_api/internal/util.rb

@@ -157,7 +157,7 @@ module SurgeAPI
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{SurgeAPI::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{SurgeAPI::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module SurgeAPI
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module SurgeAPI
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(SurgeAPI::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module SurgeAPI
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module SurgeAPI
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in SurgeAPI::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module SurgeAPI
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module SurgeAPI
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || SurgeAPI::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module SurgeAPI
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/surge_api/models/account_archive_params.rb

@@ -7,7 +7,15 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #   The ID of the account to archive.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the account to archive.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/account_retrieve_status_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute account_id
+      #   ID of the account to check
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute capabilities
       #   capabilities about which to check the status
       #
@@ -14,7 +20,9 @@ module SurgeAPI
       optional :capabilities,
                -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::AccountRetrieveStatusParams::Capability] }
 
-      # @!method initialize(capabilities: nil, request_options: {})
+      # @!method initialize(account_id:, capabilities: nil, request_options: {})
+      #   @param account_id [String] ID of the account to check
+      #
       #   @param capabilities [Array<Symbol, SurgeAPI::Models::AccountRetrieveStatusParams::Capability>] capabilities about which to check the status
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models/account_update_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #   The ID for the account to update.
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute brand_name
       #   The name by which the people this account communicates with know it. If not
       #   provided, this will match the name field.
@@ -37,10 +43,12 @@ module SurgeAPI
       #   @return [String, nil]
       optional :time_zone, String, nil?: true
 
-      # @!method initialize(brand_name: nil, name: nil, organization: nil, time_zone: nil, request_options: {})
+      # @!method initialize(id:, brand_name: nil, name: nil, organization: nil, time_zone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::AccountUpdateParams} for more details.
       #
+      #   @param id [String] The ID for the account to update.
+      #
       #   @param brand_name [String] The name by which the people this account communicates with know it. If not prov
       #
       #   @param name [String] The name of the account that will be visible for your internal organizational pu

data/lib/surge_api/models/attachment_get_file_params.rb

@@ -7,7 +7,15 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute attachment_id
+      #   The ID of the attachment.
+      #
+      #   @return [String]
+      required :attachment_id, String
+
+      # @!method initialize(attachment_id:, request_options: {})
+      #   @param attachment_id [String] The ID of the attachment.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/audience_add_contact_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute audience_id
+      #   The audience ID to add the contact to.
+      #
+      #   @return [String]
+      required :audience_id, String
+
       # @!attribute id
       #   The ID of the contact to add. The contact must belong to the same account as the
       #   audience.
@@ -14,10 +20,12 @@ module SurgeAPI
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!method initialize(audience_id:, id:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::AudienceAddContactParams} for more details.
       #
+      #   @param audience_id [String] The audience ID to add the contact to.
+      #
       #   @param id [String] The ID of the contact to add. The contact must belong to the same account as the
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models/audience_create_params.rb

@@ -7,13 +7,21 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute account_id
+      #   The account for which the audience should be created.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute name
       #   The audience name.
       #
       #   @return [String]
       required :name, String
 
-      # @!method initialize(name:, request_options: {})
+      # @!method initialize(account_id:, name:, request_options: {})
+      #   @param account_id [String] The account for which the audience should be created.
+      #
       #   @param name [String] The audience name.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models/audience_list_contacts_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute audience_id
+      #   The audience ID to list contacts for.
+      #
+      #   @return [String]
+      required :audience_id, String
+
       # @!attribute after
       #   Cursor for forward pagination. Use the next_cursor from a previous response.
       #
@@ -20,10 +26,12 @@ module SurgeAPI
       #   @return [String, nil]
       optional :before, String
 
-      # @!method initialize(after: nil, before: nil, request_options: {})
+      # @!method initialize(audience_id:, after: nil, before: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::AudienceListContactsParams} for more details.
       #
+      #   @param audience_id [String] The audience ID to list contacts for.
+      #
       #   @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
       #
       #   @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response

data/lib/surge_api/models/blast_create_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute account_id
+      #   The account for which the blast should be sent.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute attachments
       #
       #   @return [Array<SurgeAPI::Models::BlastCreateParams::Attachment>, nil]
@@ -61,10 +67,12 @@ module SurgeAPI
       #   @return [Array<String>, nil]
       optional :to, SurgeAPI::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(attachments: nil, body: nil, contacts: nil, from: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
+      # @!method initialize(account_id:, attachments: nil, body: nil, contacts: nil, from: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::BlastCreateParams} for more details.
       #
+      #   @param account_id [String] The account for which the blast should be sent.
+      #
       #   @param attachments [Array<SurgeAPI::Models::BlastCreateParams::Attachment>]
       #
       #   @param body [String, nil] The message body.

data/lib/surge_api/models/campaign_create_params.rb

@@ -7,18 +7,14 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!attribute campaign_params
-      #   Parameters for creating a new campaign. Either provide full campaign details or
-      #   import using a TCR ID.
+      # @!attribute account_id
+      #   The account for which the campaign should be created.
       #
-      #   @return [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams]
-      required :campaign_params, union: -> { SurgeAPI::CampaignParams }
+      #   @return [String]
+      required :account_id, String
 
-      # @!method initialize(campaign_params:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {SurgeAPI::Models::CampaignCreateParams} for more details.
-      #
-      #   @param campaign_params [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String] The account for which the campaign should be created.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/surge_api/models/campaign_list_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute account_id
+      #   The account ID to list campaigns for.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute after
       #   Cursor for forward pagination. Use the next_cursor from a previous response.
       #
@@ -20,10 +26,12 @@ module SurgeAPI
       #   @return [String, nil]
       optional :before, String
 
-      # @!method initialize(after: nil, before: nil, request_options: {})
+      # @!method initialize(account_id:, after: nil, before: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::CampaignListParams} for more details.
       #
+      #   @param account_id [String] The account ID to list campaigns for.
+      #
       #   @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
       #
       #   @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response

data/lib/surge_api/models/campaign_retrieve_params.rb

@@ -7,7 +7,15 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute id
+      #   The ID of the campaign to retrieve.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the campaign to retrieve.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/campaign_update_params.rb

@@ -7,18 +7,14 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!attribute campaign_params
-      #   Parameters for creating a new campaign. Either provide full campaign details or
-      #   import using a TCR ID.
+      # @!attribute id
+      #   The ID of the campaign to update.
       #
-      #   @return [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams]
-      required :campaign_params, union: -> { SurgeAPI::CampaignParams }
+      #   @return [String]
+      required :id, String
 
-      # @!method initialize(campaign_params:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {SurgeAPI::Models::CampaignUpdateParams} for more details.
-      #
-      #   @param campaign_params [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the campaign to update.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/surge_api/models/contact_create_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute account_id
+      #   The account for which the contact should be created.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute phone_number
       #   The contact's phone number in E.164 format.
       #
@@ -37,7 +43,9 @@ module SurgeAPI
       #   @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, request_options: {})
+      # @!method initialize(account_id:, phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil, request_options: {})
+      #   @param account_id [String] The account for which the contact should be created.
+      #
       #   @param phone_number [String] The contact's phone number in E.164 format.
       #
       #   @param email [String] The contact's email address.