trycourier 4.7.1 → 4.9.0

data/lib/courier/models/brand_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute brand_id
+      #
+      #   @return [String]
+      required :brand_id, String
+
       # @!attribute name
       #   The name of the brand.
       #
@@ -23,7 +28,9 @@ module Courier
       #   @return [Courier::Models::BrandSnippets, nil]
       optional :snippets, -> { Courier::BrandSnippets }, nil?: true
 
-      # @!method initialize(name:, settings: nil, snippets: nil, request_options: {})
+      # @!method initialize(brand_id:, name:, settings: nil, snippets: nil, request_options: {})
+      #   @param brand_id [String]
+      #
       #   @param name [String] The name of the brand.
       #
       #   @param settings [Courier::Models::BrandSettings, nil]

data/lib/courier/models/bulk_add_users_params.rb

@@ -7,12 +7,18 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
       # @!attribute users
       #
       #   @return [Array<Courier::Models::InboundBulkMessageUser>]
       required :users, -> { Courier::Internal::Type::ArrayOf[Courier::InboundBulkMessageUser] }
 
-      # @!method initialize(users:, request_options: {})
+      # @!method initialize(job_id:, users:, request_options: {})
+      #   @param job_id [String]
       #   @param users [Array<Courier::Models::InboundBulkMessageUser>]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/bulk_list_users_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
       # @!attribute cursor
       #   A unique identifier that allows for fetching the next set of users added to the
       #   bulk job
@@ -14,10 +19,12 @@ module Courier
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
-      # @!method initialize(cursor: nil, request_options: {})
+      # @!method initialize(job_id:, cursor: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::BulkListUsersParams} for more details.
       #
+      #   @param job_id [String]
+      #
       #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/bulk_retrieve_job_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!method initialize(job_id:, request_options: {})
+      #   @param job_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/bulk_run_job_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute job_id
+      #
+      #   @return [String]
+      required :job_id, String
+
+      # @!method initialize(job_id:, request_options: {})
+      #   @param job_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/channel.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Channel < Courier::Internal::Type::BaseModel
+      # @!attribute brand_id
+      #   Brand id used for rendering.
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
+      # @!attribute if_
+      #   JS conditional with access to data/profile.
+      #
+      #   @return [String, nil]
+      optional :if_, String, api_name: :if, nil?: true
+
+      # @!attribute metadata
+      #
+      #   @return [Courier::Models::ChannelMetadata, nil]
+      optional :metadata, -> { Courier::ChannelMetadata }, nil?: true
+
+      # @!attribute override
+      #   Channel specific overrides.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute providers
+      #   Providers enabled for this channel.
+      #
+      #   @return [Array<String>, nil]
+      optional :providers, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute routing_method
+      #   Defaults to `single`.
+      #
+      #   @return [Symbol, Courier::Models::Channel::RoutingMethod, nil]
+      optional :routing_method, enum: -> { Courier::Channel::RoutingMethod }, nil?: true
+
+      # @!attribute timeouts
+      #
+      #   @return [Courier::Models::Timeouts, nil]
+      optional :timeouts, -> { Courier::Timeouts }, nil?: true
+
+      # @!method initialize(brand_id: nil, if_: nil, metadata: nil, override: nil, providers: nil, routing_method: nil, timeouts: nil)
+      #   @param brand_id [String, nil] Brand id used for rendering.
+      #
+      #   @param if_ [String, nil] JS conditional with access to data/profile.
+      #
+      #   @param metadata [Courier::Models::ChannelMetadata, nil]
+      #
+      #   @param override [Hash{Symbol=>Object}, nil] Channel specific overrides.
+      #
+      #   @param providers [Array<String>, nil] Providers enabled for this channel.
+      #
+      #   @param routing_method [Symbol, Courier::Models::Channel::RoutingMethod, nil] Defaults to `single`.
+      #
+      #   @param timeouts [Courier::Models::Timeouts, nil]
+
+      # Defaults to `single`.
+      #
+      # @see Courier::Models::Channel#routing_method
+      module RoutingMethod
+        extend Courier::Internal::Type::Enum
+
+        ALL = :all
+        SINGLE = :single
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/channel_metadata.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ChannelMetadata < Courier::Internal::Type::BaseModel
+      # @!attribute utm
+      #
+      #   @return [Courier::Models::Utm, nil]
+      optional :utm, -> { Courier::Utm }, nil?: true
+
+      # @!method initialize(utm: nil)
+      #   @param utm [Courier::Models::Utm, nil]
+    end
+  end
+end

data/lib/courier/models/elemental_content.rb

@@ -5,7 +5,7 @@ module Courier
     class ElementalContent < Courier::Internal::Type::BaseModel
       # @!attribute elements
       #
-      #   @return [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType>]
+      #   @return [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
       required :elements, -> { Courier::Internal::Type::ArrayOf[union: Courier::ElementalNode] }
 
       # @!attribute version
@@ -14,17 +14,10 @@ module Courier
       #   @return [String]
       required :version, String
 
-      # @!attribute brand
-      #
-      #   @return [String, nil]
-      optional :brand, String, nil?: true
-
-      # @!method initialize(elements:, version:, brand: nil)
-      #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType>]
+      # @!method initialize(elements:, version:)
+      #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
       #
       #   @param version [String] For example, "2022-01-01"
-      #
-      #   @param brand [String, nil]
     end
   end
 end

data/lib/courier/models/elemental_html_node_with_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementalHTMLNodeWithType < Courier::Models::ElementalBaseNode
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::ElementalHTMLNodeWithType::Type, nil]
+      optional :type, enum: -> { Courier::ElementalHTMLNodeWithType::Type }
+
+      # @!method initialize(type: nil)
+      #   @param type [Symbol, Courier::Models::ElementalHTMLNodeWithType::Type]
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        HTML = :html
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/elemental_node.rb

@@ -37,8 +37,10 @@ module Courier
 
       variant -> { Courier::ElementalQuoteNodeWithType }
 
+      variant -> { Courier::ElementalHTMLNodeWithType }
+
       # @!method self.variants
-      #   @return [Array(Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType)]
+      #   @return [Array(Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType)]
     end
   end
 end

data/lib/courier/models/journey.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Journey < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the journey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #   The name of the journey.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute version
+      #   The version of the journey (published or draft).
+      #
+      #   @return [Symbol, Courier::Models::Journey::Version]
+      required :version, enum: -> { Courier::Journey::Version }
+
+      # @!attribute created_at
+      #   ISO 8601 timestamp when the journey was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute updated_at
+      #   ISO 8601 timestamp when the journey was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, name:, version:, created_at: nil, updated_at: nil)
+      #   A journey template representing an automation workflow.
+      #
+      #   @param id [String] The unique identifier of the journey.
+      #
+      #   @param name [String] The name of the journey.
+      #
+      #   @param version [Symbol, Courier::Models::Journey::Version] The version of the journey (published or draft).
+      #
+      #   @param created_at [Time] ISO 8601 timestamp when the journey was created.
+      #
+      #   @param updated_at [Time] ISO 8601 timestamp when the journey was last updated.
+
+      # The version of the journey (published or draft).
+      #
+      # @see Courier::Models::Journey#version
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_invoke_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#invoke
+    class JourneyInvokeParams < Courier::Models::JourneysInvokeRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!method initialize(template_id:, request_options: {})
+      #   @param template_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/journey_list_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list
+    class JourneyListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A cursor token for pagination. Use the cursor from the previous response to
+      #   fetch the next page of results.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute version
+      #   The version of journeys to retrieve. Accepted values are published (for
+      #   published journeys) or draft (for draft journeys). Defaults to published.
+      #
+      #   @return [Symbol, Courier::Models::JourneyListParams::Version, nil]
+      optional :version, enum: -> { Courier::JourneyListParams::Version }
+
+      # @!method initialize(cursor: nil, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyListParams} for more details.
+      #
+      #   @param cursor [String] A cursor token for pagination. Use the cursor from the previous response to fetc
+      #
+      #   @param version [Symbol, Courier::Models::JourneyListParams::Version] The version of journeys to retrieve. Accepted values are published (for publishe
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+      # The version of journeys to retrieve. Accepted values are published (for
+      # published journeys) or draft (for draft journeys). Defaults to published.
+      module Version
+        extend Courier::Internal::Type::Enum
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys_invoke_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneysInvokeRequest < Courier::Internal::Type::BaseModel
+      # @!attribute data
+      #   Data payload passed to the journey. The expected shape can be predefined using
+      #   the schema builder in the journey editor. This data is available in journey
+      #   steps for condition evaluation and template variable interpolation. Can also
+      #   contain user identifiers (user_id, userId, anonymousId) if not provided
+      #   elsewhere.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute profile
+      #   Profile data for the user. Can contain contact information (email,
+      #   phone_number), user identifiers (user_id, userId, anonymousId), or any custom
+      #   profile fields. Profile fields are merged with any existing stored profile for
+      #   the user. Include context.tenant_id to load a tenant-scoped profile for
+      #   multi-tenant scenarios.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute user_id
+      #   A unique identifier for the user. If not provided, the system will attempt to
+      #   resolve the user identifier from profile or data objects.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(data: nil, profile: nil, user_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneysInvokeRequest} for more details.
+      #
+      #   Request body for invoking a journey. Requires either a user identifier or a
+      #   profile with contact information. User identifiers can be provided via user_id
+      #   field, or resolved from profile/data objects (user_id, userId, or anonymousId
+      #   fields).
+      #
+      #   @param data [Hash{Symbol=>Object}] Data payload passed to the journey. The expected shape can be predefined using t
+      #
+      #   @param profile [Hash{Symbol=>Object}] Profile data for the user. Can contain contact information (email, phone_number)
+      #
+      #   @param user_id [String] A unique identifier for the user. If not provided, the system will attempt to re
+    end
+  end
+end

data/lib/courier/models/journeys_invoke_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#invoke
+    class JourneysInvokeResponse < Courier::Internal::Type::BaseModel
+      # @!attribute run_id
+      #   A unique identifier for the journey run that was created.
+      #
+      #   @return [String]
+      required :run_id, String, api_name: :runId
+
+      # @!method initialize(run_id:)
+      #   @param run_id [String] A unique identifier for the journey run that was created.
+    end
+  end
+end

data/lib/courier/models/journeys_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list
+    class JourneysListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute cursor
+      #   A cursor token for pagination. Present when there are more results available.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute templates
+      #
+      #   @return [Array<Courier::Models::Journey>, nil]
+      optional :templates, -> { Courier::Internal::Type::ArrayOf[Courier::Journey] }
+
+      # @!method initialize(cursor: nil, templates: nil)
+      #   @param cursor [String] A cursor token for pagination. Present when there are more results available.
+      #
+      #   @param templates [Array<Courier::Models::Journey>]
+    end
+  end
+end

data/lib/courier/models/list_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_restore_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
+      # @!method initialize(list_id:, request_options: {})
+      #   @param list_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/list_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute list_id
+      #
+      #   @return [String]
+      required :list_id, String
+
       # @!attribute name
       #
       #   @return [String]
@@ -17,7 +22,8 @@ module Courier
       #   @return [Courier::Models::RecipientPreferences, nil]
       optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
 
-      # @!method initialize(name:, preferences: nil, request_options: {})
+      # @!method initialize(list_id:, name:, preferences: nil, request_options: {})
+      #   @param list_id [String]
       #   @param name [String]
       #   @param preferences [Courier::Models::RecipientPreferences, nil]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/lists/subscription_add_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute recipients
         #
         #   @return [Array<Courier::Models::PutSubscriptionsRecipient>]
         required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] }
 
-        # @!method initialize(recipients:, request_options: {})
+        # @!method initialize(list_id:, recipients:, request_options: {})
+        #   @param list_id [String]
         #   @param recipients [Array<Courier::Models::PutSubscriptionsRecipient>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_list_params.rb

@@ -8,13 +8,20 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute cursor
         #   A unique identifier that allows for fetching the next set of list subscriptions
         #
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!method initialize(cursor: nil, request_options: {})
+        # @!method initialize(list_id:, cursor: nil, request_options: {})
+        #   @param list_id [String]
+        #
         #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of list subscriptions
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/lists/subscription_subscribe_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute list_id
+        #
+        #   @return [String]
+        required :list_id, String
+
         # @!attribute recipients
         #
         #   @return [Array<Courier::Models::PutSubscriptionsRecipient>]
         required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] }
 
-        # @!method initialize(recipients:, request_options: {})
+        # @!method initialize(list_id:, recipients:, request_options: {})
+        #   @param list_id [String]
         #   @param recipients [Array<Courier::Models::PutSubscriptionsRecipient>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_subscribe_user_params.rb

@@ -13,13 +13,19 @@ module Courier
         #   @return [String]
         required :list_id, String
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute preferences
         #
         #   @return [Courier::Models::RecipientPreferences, nil]
         optional :preferences, -> { Courier::RecipientPreferences }, nil?: true
 
-        # @!method initialize(list_id:, preferences: nil, request_options: {})
+        # @!method initialize(list_id:, user_id:, preferences: nil, request_options: {})
         #   @param list_id [String]
+        #   @param user_id [String]
         #   @param preferences [Courier::Models::RecipientPreferences, nil]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/lists/subscription_unsubscribe_user_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :list_id, String
 
-        # @!method initialize(list_id:, request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(list_id:, user_id:, request_options: {})
         #   @param list_id [String]
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end