surge_api 0.17.0 → 0.18.0

data/lib/surge_api/models/contact_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 contacts 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::ContactListParams} for more details.
       #
+      #   @param account_id [String] The account 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/contact_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 contact to retrieve.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the contact to retrieve.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/contact_update_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #   The ID of the contact to update.
+      #
+      #   @return [String]
+      required :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(id:, phone_number:, email: nil, first_name: nil, last_name: nil, metadata: nil, request_options: {})
+      #   @param id [String] The ID of the contact to update.
+      #
       #   @param phone_number [String] The contact's phone number in E.164 format.
       #
       #   @param email [String] The contact's email address.

data/lib/surge_api/models/message.rb

@@ -95,6 +95,7 @@ module SurgeAPI
           FILE = :file
           IMAGE = :image
           LINK = :link
+          CONTACT = :contact
           VIDEO = :video
 
           # @!method self.values

data/lib/surge_api/models/message_create_params.rb

@@ -7,19 +7,14 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!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.
+      # @!attribute account_id
+      #   The account from which the message should be sent.
       #
-      #   @return [SurgeAPI::Models::MessageParams::MessageParamsWithConversation, SurgeAPI::Models::MessageParams::SimpleMessageParams]
-      required :message_params, union: -> { SurgeAPI::MessageParams }
+      #   @return [String]
+      required :account_id, String
 
-      # @!method initialize(message_params:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {SurgeAPI::Models::MessageCreateParams} for more details.
-      #
-      #   @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.
+      # @!method initialize(account_id:, request_options: {})
+      #   @param account_id [String] The account from which the message should be sent.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -167,6 +167,7 @@ module SurgeAPI
             FILE = :file
             IMAGE = :image
             LINK = :link
+            CONTACT = :contact
             VIDEO = :video
 
             # @!method self.values

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -175,6 +175,7 @@ module SurgeAPI
             FILE = :file
             IMAGE = :image
             LINK = :link
+            CONTACT = :contact
             VIDEO = :video
 
             # @!method self.values

data/lib/surge_api/models/message_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 messages 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::MessageListParams} for more details.
       #
+      #   @param account_id [String] The account ID to list messages 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/message_params.rb

@@ -47,7 +47,13 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(conversation:, attachments: nil, body: nil, metadata: nil, send_at: nil)
+        # @!attribute settings
+        #   Per-message setting overrides.
+        #
+        #   @return [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Settings, nil]
+        optional :settings, -> { SurgeAPI::MessageParams::MessageParamsWithConversation::Settings }
+
+        # @!method initialize(conversation:, attachments: nil, body: nil, metadata: nil, send_at: nil, settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::MessageParamsWithConversation} for more
         #   details.
@@ -64,6 +70,8 @@ module SurgeAPI
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
+        #
+        #   @param settings [SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Settings] Per-message setting overrides.
 
         # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation#conversation
         class Conversation < SurgeAPI::Internal::Type::BaseModel
@@ -151,6 +159,34 @@ module SurgeAPI
           #
           #   @param url [String] The URL of the attachment.
         end
+
+        # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation#settings
+        class Settings < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute link_shortening
+          #   Override link shortening for this message.
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Settings::LinkShortening, nil]
+          optional :link_shortening,
+                   enum: -> { SurgeAPI::MessageParams::MessageParamsWithConversation::Settings::LinkShortening }
+
+          # @!method initialize(link_shortening: nil)
+          #   Per-message setting overrides.
+          #
+          #   @param link_shortening [Symbol, SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Settings::LinkShortening] Override link shortening for this message.
+
+          # Override link shortening for this message.
+          #
+          # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation::Settings#link_shortening
+          module LinkShortening
+            extend SurgeAPI::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
 
       class SimpleMessageParams < SurgeAPI::Internal::Type::BaseModel
@@ -193,7 +229,13 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(to:, attachments: nil, body: nil, from: nil, metadata: nil, send_at: nil)
+        # @!attribute settings
+        #   Per-message setting overrides.
+        #
+        #   @return [SurgeAPI::Models::MessageParams::SimpleMessageParams::Settings, nil]
+        optional :settings, -> { SurgeAPI::MessageParams::SimpleMessageParams::Settings }
+
+        # @!method initialize(to:, attachments: nil, body: nil, from: nil, metadata: nil, send_at: nil, settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::SimpleMessageParams} for more details.
         #
@@ -210,6 +252,8 @@ module SurgeAPI
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
+        #
+        #   @param settings [SurgeAPI::Models::MessageParams::SimpleMessageParams::Settings] Per-message setting overrides.
 
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute url
@@ -223,6 +267,34 @@ module SurgeAPI
           #
           #   @param url [String] The URL of the attachment.
         end
+
+        # @see SurgeAPI::Models::MessageParams::SimpleMessageParams#settings
+        class Settings < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute link_shortening
+          #   Override link shortening for this message.
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageParams::SimpleMessageParams::Settings::LinkShortening, nil]
+          optional :link_shortening,
+                   enum: -> { SurgeAPI::MessageParams::SimpleMessageParams::Settings::LinkShortening }
+
+          # @!method initialize(link_shortening: nil)
+          #   Per-message setting overrides.
+          #
+          #   @param link_shortening [Symbol, SurgeAPI::Models::MessageParams::SimpleMessageParams::Settings::LinkShortening] Override link shortening for this message.
+
+          # Override link shortening for this message.
+          #
+          # @see SurgeAPI::Models::MessageParams::SimpleMessageParams::Settings#link_shortening
+          module LinkShortening
+            extend SurgeAPI::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
 
       # @!method self.variants

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -167,6 +167,7 @@ module SurgeAPI
             FILE = :file
             IMAGE = :image
             LINK = :link
+            CONTACT = :contact
             VIDEO = :video
 
             # @!method self.values

data/lib/surge_api/models/message_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 message to retrieve.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the message to retrieve.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -167,6 +167,7 @@ module SurgeAPI
             FILE = :file
             IMAGE = :image
             LINK = :link
+            CONTACT = :contact
             VIDEO = :video
 
             # @!method self.values

data/lib/surge_api/models/phone_number.rb

@@ -2,7 +2,7 @@
 
 module SurgeAPI
   module Models
-    # @see SurgeAPI::Resources::PhoneNumbers#list
+    # @see SurgeAPI::Resources::PhoneNumbers#update
     class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
       # @!attribute id
       #   Unique identifier for the phone number

data/lib/surge_api/models/phone_number_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 phone numbers 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::PhoneNumberListParams} for more details.
       #
+      #   @param account_id [String] The account ID to list phone numbers 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/phone_number_purchase_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 phone number should be created.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute area_code
       #   The desired area code for this phone number. If provided without type, the type
       #   will be inferred.
@@ -42,10 +48,12 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::PhoneNumberPurchaseParams::Type, nil]
       optional :type, enum: -> { SurgeAPI::PhoneNumberPurchaseParams::Type }
 
-      # @!method initialize(area_code: nil, latitude: nil, longitude: nil, name: nil, type: nil, request_options: {})
+      # @!method initialize(account_id:, area_code: nil, latitude: nil, longitude: nil, name: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::PhoneNumberPurchaseParams} for more details.
       #
+      #   @param account_id [String] The account for which the phone number should be created.
+      #
       #   @param area_code [String] The desired area code for this phone number. If provided without type, the type
       #
       #   @param latitude [Float] Latitude to search for nearby phone numbers. Must be used with longitude. If pro

data/lib/surge_api/models/phone_number_release_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::PhoneNumbers#release
+    class PhoneNumberReleaseParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the phone number to release.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the phone number to release.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/phone_number_update_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::PhoneNumbers#update
+    class PhoneNumberUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the phone number to update.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute campaign_id
+      #   Campaign ID to attach this number to (`cpn_...`).
+      #
+      #   @return [String, nil]
+      optional :campaign_id, 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: {})
+      #   @param id [String] The ID of the phone number to update.
+      #
+      #   @param campaign_id [String] Campaign ID to attach this number to (`cpn_...`).
+      #
+      #   @param name [String] A human-readable name for the phone number.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/recording_delete_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 recording.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the recording.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/recording_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 recording_id
+      #   The ID of the recording.
+      #
+      #   @return [String]
+      required :recording_id, String
+
+      # @!method initialize(recording_id:, request_options: {})
+      #   @param recording_id [String] The ID of the recording.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/recording_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 recordings 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::RecordingListParams} for more details.
       #
+      #   @param account_id [String] The account ID to list recordings 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/recording_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 recording to retrieve.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the recording to retrieve.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/user_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 user should be created.
+      #
+      #   @return [String]
+      required :account_id, String
+
       # @!attribute first_name
       #   The user's first name.
       #
@@ -31,7 +37,9 @@ module SurgeAPI
       #   @return [String, nil]
       optional :photo_url, String
 
-      # @!method initialize(first_name:, last_name: nil, metadata: nil, photo_url: nil, request_options: {})
+      # @!method initialize(account_id:, first_name:, last_name: nil, metadata: nil, photo_url: nil, request_options: {})
+      #   @param account_id [String] The account for which the user should be created.
+      #
       #   @param first_name [String] The user's first name.
       #
       #   @param last_name [String] The user's last name.

data/lib/surge_api/models/user_create_token_params.rb

@@ -7,13 +7,21 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #   The user for which the token represents authentication.
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute duration_seconds
       #   For how many seconds the token should be accepted. Defaults to 15 minutes.
       #
       #   @return [Integer, nil]
       optional :duration_seconds, Integer
 
-      # @!method initialize(duration_seconds: nil, request_options: {})
+      # @!method initialize(user_id:, duration_seconds: nil, request_options: {})
+      #   @param user_id [String] The user for which the token represents authentication.
+      #
       #   @param duration_seconds [Integer] For how many seconds the token should be accepted. Defaults to 15 minutes.
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models/user_delete_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 user to delete.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the user to delete.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/user_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 users 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::UserListParams} for more details.
       #
+      #   @param account_id [String] The account ID to list users 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/user_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 user to retrieve.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the user to retrieve.
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models/user_update_params.rb

@@ -7,6 +7,12 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
+      # @!attribute id
+      #   The ID of the user to update.
+      #
+      #   @return [String]
+      required :id, String
+
       # @!attribute first_name
       #   The user's first name.
       #
@@ -31,7 +37,9 @@ module SurgeAPI
       #   @return [String, nil]
       optional :photo_url, String
 
-      # @!method initialize(first_name:, last_name: nil, metadata: nil, photo_url: nil, request_options: {})
+      # @!method initialize(id:, first_name:, last_name: nil, metadata: nil, photo_url: nil, request_options: {})
+      #   @param id [String] The ID of the user to update.
+      #
       #   @param first_name [String] The user's first name.
       #
       #   @param last_name [String] The user's last name.