sentdm 0.30.0 → 0.32.0

data/lib/sentdm/models/template.rb

@@ -2,6 +2,7 @@
 
 module Sentdm
   module Models
+    # @see Sentdm::Resources::Templates#list
     class Template < Sentdm::Internal::Type::BaseModel
       # @!attribute customer_id
       #   Which customer owns this — the key's own, or the profile named in x-profile-id.
@@ -16,6 +17,23 @@ module Sentdm
       #   @return [String, nil]
       optional :id, String
 
+      # @!attribute auto_reply_action
+      #   Which consent keyword this template answers, when it is one of Sent's
+      #   auto-replies: OPT_IN, OPT_OUT, HELP, or OTHER for a customer-defined keyword.
+      #   Null for an ordinary template, and omitted from the response, so its presence is
+      #   the answer to "is this an auto-reply".
+      #
+      #   Deliberately not required, unlike CustomerId, even though the same "no single
+      #   mapper" argument applies: NJsonSchema publishes a C# required member in the
+      #   schema's required array, so the contract would have advertised a field this
+      #   response omits for every ordinary template, and a generated client could refuse
+      #   the common case. A compile-time guard is not worth a wrong published contract.
+      #   Every mapping site sets it explicitly, and TemplateResponseSchemaTests pins the
+      #   field as optional so it cannot be reintroduced.
+      #
+      #   @return [String, nil]
+      optional :auto_reply_action, String, nil?: true
+
       # @!attribute category
       #   Template category: MARKETING, UTILITY, AUTHENTICATION
       #
@@ -23,7 +41,18 @@ module Sentdm
       optional :category, String
 
       # @!attribute channels
-      #   Supported channels: sms, whatsapp
+      #   The channels this template's definition can render on, in canonical order: sms,
+      #   whatsapp, rcs.
+      #
+      #   Derived from the definition's body, mirroring each channel's send-time fallback
+      #   chain, so a channel is listed only when a real body would be produced for it:
+      #   SMS reads sms ?? multiChannel, WhatsApp reads whatsapp ?? multiChannel, and RCS
+      #   reads rcs ?? multiChannel ?? sms. A multiChannel body therefore reports all
+      #   three, and the extra SMS fallback on RCS is why an sms/whatsapp pair reports RCS
+      #   too.
+      #
+      #   This says what the content can render on, not what may be sent: sending also
+      #   needs the template approved for that channel.
       #
       #   @return [Array<String>, nil]
       optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
@@ -53,7 +82,8 @@ module Sentdm
       optional :name, String
 
       # @!attribute status
-      #   Template status: APPROVED, PENDING, REJECTED
+      #   Template status: DRAFT, PENDING, APPROVED, REJECTED. A template created with
+      #   submit_for_review: false starts as DRAFT and stays there until it is submitted.
       #
       #   @return [String, nil]
       optional :status, String
@@ -70,7 +100,7 @@ module Sentdm
       #   @return [Array<String>, nil]
       optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
+      # @!method initialize(customer_id:, id: nil, auto_reply_action: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
       #   Some parameter documentations has been truncated, see {Sentdm::Models::Template}
       #   for more details.
       #
@@ -80,9 +110,11 @@ module Sentdm
       #
       #   @param id [String] Unique template identifier
       #
+      #   @param auto_reply_action [String, nil] Which consent keyword this template answers, when it is one of Sent's auto-repli
+      #
       #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
       #
-      #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
+      #   @param channels [Array<String>, nil] The channels this template's definition can render on, in canonical order: sms,
       #
       #   @param created_at [Time] When the template was created
       #
@@ -92,7 +124,7 @@ module Sentdm
       #
       #   @param name [String] Template display name
       #
-      #   @param status [String] Template status: APPROVED, PENDING, REJECTED
+      #   @param status [String] Template status: DRAFT, PENDING, APPROVED, REJECTED. A template created with
       #
       #   @param updated_at [Time, nil] When the template was last updated
       #

data/lib/sentdm/models/template_body.rb

@@ -4,27 +4,27 @@ module Sentdm
   module Models
     class TemplateBody < Sentdm::Internal::Type::BaseModel
       # @!attribute multi_channel
-      #   Content that will be used for all channels (SMS and WhatsApp) unless
-      #   channel-specific content is provided
+      #   The shared body, used for every channel. One half of the choice described above.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
 
       # @!attribute rcs
-      #   RCS-specific content that overrides multi-channel content for RCS messages
+      #   RCS-specific copy that overrides the chosen strategy for RCS only. The one true
+      #   override: optional on top of either strategy, but it cannot be the only body
+      #   present. Its length cap is the higher one described on Template.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :rcs, -> { Sentdm::TemplateBodyContent }, nil?: true
 
       # @!attribute sms
-      #   SMS-specific content that overrides multi-channel content for SMS messages
+      #   The SMS body. It does not override multiChannel, it replaces it.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
 
       # @!attribute whatsapp
-      #   WhatsApp-specific content that overrides multi-channel content for WhatsApp
-      #   messages
+      #   The WhatsApp body. It does not override multiChannel, it replaces it.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
@@ -33,15 +33,24 @@ module Sentdm
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateBody} for more details.
       #
-      #   Body section of a message template with channel-specific content
+      #   Body section of a message template.
       #
-      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
+      #   A body picks one of two authoring strategies, and mixing them is refused
+      #   (TemplateDefinitionValidator.HaveValidChannelConfiguration): a shared
+      #   multiChannel body on its own, or an explicit sms + whatsapp pair, both present.
       #
-      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific content that overrides multi-channel content for RCS messages
+      #   multiChannel together with sms or whatsapp is rejected, and so is sms or
+      #   whatsapp on its own — every template is expected to be deliverable on every
+      #   channel. rcs is the one true override: it may accompany either strategy to vary
+      #   the copy, but cannot stand alone.
       #
-      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
+      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] The shared body, used for every channel. One half of the choice described above.
       #
-      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
+      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific copy that overrides the chosen strategy for RCS only. The one true
+      #
+      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] The SMS body. It does not override multiChannel, it replaces it.
+      #
+      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] The WhatsApp body. It does not override multiChannel, it replaces it.
     end
   end
 end

data/lib/sentdm/models/template_body_content.rb

@@ -4,24 +4,56 @@ module Sentdm
   module Models
     class TemplateBodyContent < Sentdm::Internal::Type::BaseModel
       # @!attribute template
+      #   The body copy, with variables written as {{index:variable}}.
+      #
+      #   Length cap depends on which channel this body belongs to:
+      #   TemplateContentLimits.MaxBodyLength (1024) for multiChannel, sms and whatsapp —
+      #   Meta's BODY limit, which a multiChannel body may be delivered under — and
+      #   TemplateContentLimits.MaxRcsBodyLength (3072) for an rcs body, which never
+      #   reaches Meta. The maxLength advertised on this schema is the 1024 one, because
+      #   all four channel bodies share this single schema — an rcs body between the two
+      #   is accepted.
+      #
+      #   Meta requires every variable to carry surrounding context, so a body is refused
+      #   unless it also satisfies all of the following (enforced by
+      #   TemplateDefinitionValidator): At least one letter before the first variable and
+      #   after the last — trailing punctuation such as "... {{1:variable}}." does not
+      #   count. At least (2 × variable count) + 1 words once the placeholders are
+      #   removed. No two variables adjacent with only whitespace between them. No leading
+      #   or trailing newline, no more than two consecutive line breaks, and no more than
+      #   four consecutive spaces.
+      #
+      #   Example: "Hello {{0:variable}}! Welcome to {{1:variable}}. We are glad to have
+      #   you on board." — two variables, so at least five words are required, and the
+      #   copy after the final variable contains letters.
       #
       #   @return [String]
       required :template, String
 
       # @!attribute type
+      #   The type of body content — send "text". It is dropped from the stored definition
+      #   when null, so a body posted without it is saved with no type key at all and the
+      #   template editor has nothing to render the block from.
       #
       #   @return [String, nil]
       optional :type, String, nil?: true
 
       # @!attribute variables
+      #   The variables referenced by the body copy, one entry per {{index:variable}}
+      #   placeholder.
       #
       #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
       optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
 
       # @!method initialize(template:, type: nil, variables: nil)
-      #   @param template [String]
-      #   @param type [String, nil]
-      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateBodyContent} for more details.
+      #
+      #   @param template [String] The body copy, with variables written as {{index:variable}}.
+      #
+      #   @param type [String, nil] The type of body content — send "text". It is dropped from the stored definition
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] The variables referenced by the body copy, one entry per {{index:variable}} plac
     end
   end
 end

data/lib/sentdm/models/template_button.rb

@@ -16,7 +16,13 @@ module Sentdm
       required :type, String
 
       # @!attribute id
-      #   The unique identifier of the button (1-based index)
+      #   The button's identifier (1-based index), unique within the template.
+      #
+      #   Omitting it is only safe for a template holding a single button. The field is a
+      #   non-nullable int, so every button that leaves it out defaults to 0, and two such
+      #   buttons are refused by the unique-id rule ("Button IDs must be unique"). Number
+      #   them from 1 in the order they should appear — order matters on RCS, where only
+      #   the first four buttons render.
       #
       #   @return [Integer, nil]
       optional :id, Integer
@@ -31,7 +37,7 @@ module Sentdm
       #
       #   @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
       #
-      #   @param id [Integer] The unique identifier of the button (1-based index)
+      #   @param id [Integer] The button's identifier (1-based index), unique within the template.
     end
   end
 end

data/lib/sentdm/models/template_button_props.rb

@@ -29,6 +29,17 @@ module Sentdm
       required :quick_reply_type, String, api_name: :quickReplyType
 
       # @!attribute text
+      #   The button's label. Required for every button type, and capped at
+      #   TemplateContentLimits.MaxButtonTextLength (25) characters.
+      #
+      #   Meta accepts only static text here, so a label is refused when it contains a
+      #   {{...}} variable placeholder, a newline, an emoji, or WhatsApp formatting markup
+      #   (\*, \_, ~) — enforced by ApplyButtonLabelContentRules in
+      #   TemplateButtonValidator. Meta reports all four as one error: "Buttons can't have
+      #   any variables, newlines, emojis, or formatting characters."
+      #
+      #   AUTHENTICATION OTP buttons are the exception: Meta auto-localizes their label
+      #   from the template language, and the converter drops whatever text was sent.
       #
       #   @return [String]
       required :text, String
@@ -85,7 +96,7 @@ module Sentdm
       #
       #   @param quick_reply_type [String]
       #
-      #   @param text [String]
+      #   @param text [String] The button's label. Required for every button type, and capped at
       #
       #   @param url [String]
       #

data/lib/sentdm/models/template_definition.rb

@@ -4,7 +4,16 @@ module Sentdm
   module Models
     class TemplateDefinition < Sentdm::Internal::Type::BaseModel
       # @!attribute body
-      #   Body section of a message template with channel-specific content
+      #   Body section of a message template.
+      #
+      #   A body picks one of two authoring strategies, and mixing them is refused
+      #   (TemplateDefinitionValidator.HaveValidChannelConfiguration): a shared
+      #   multiChannel body on its own, or an explicit sms + whatsapp pair, both present.
+      #
+      #   multiChannel together with sms or whatsapp is rejected, and so is sms or
+      #   whatsapp on its own — every template is expected to be deliverable on every
+      #   channel. rcs is the one true override: it may accompany either strategy to vary
+      #   the copy, but cannot stand alone.
       #
       #   @return [Sentdm::Models::TemplateBody]
       required :body, -> { Sentdm::TemplateBody }
@@ -43,10 +52,13 @@ module Sentdm
       optional :header, -> { Sentdm::TemplateHeader }, nil?: true
 
       # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateDefinition} for more details.
+      #
       #   Complete definition of a message template including header, body, footer, and
       #   buttons
       #
-      #   @param body [Sentdm::Models::TemplateBody] Body section of a message template with channel-specific content
+      #   @param body [Sentdm::Models::TemplateBody] Body section of a message template.
       #
       #   @param authentication_config [Sentdm::Models::AuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
       #

data/lib/sentdm/models/template_event.rb

@@ -4,16 +4,16 @@ module Sentdm
   module Models
     class TemplateEvent < Sentdm::Internal::Type::BaseModel
       # @!attribute event
-      #   The specific event within the family, for example message.delivered or
-      #   message.received. Absent on events that have no subtype, so treat it as
-      #   optional.
+      #   The specific event within the family, for example message.delivered,
+      #   message.received or contact.opt_out. Absent on events that have no subtype, so
+      #   treat it as optional.
       #
       #   @return [String, nil]
       optional :event, String, nil?: true
 
       # @!attribute field
-      #   The event family, for example message or templates. Route on this first, then on
-      #   event for the specific change.
+      #   The event family, for example message, templates or contact. Route on this
+      #   first, then on event for the specific change.
       #
       #   @return [String, nil]
       optional :field, String
@@ -25,6 +25,12 @@ module Sentdm
       #   @return [Sentdm::Models::TemplateEventPayload, nil]
       optional :payload, -> { Sentdm::TemplateEventPayload }, nil?: true
 
+      # @!attribute request_id
+      #   The event-specific body.
+      #
+      #   @return [String, nil]
+      optional :request_id, String, nil?: true
+
       # @!attribute timestamp
       #   When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
       #   time, not the time the underlying change happened. Use the timestamp inside the
@@ -33,19 +39,21 @@ module Sentdm
       #   @return [String, nil]
       optional :timestamp, String
 
-      # @!method initialize(event: nil, field: nil, payload: nil, timestamp: nil)
+      # @!method initialize(event: nil, field: nil, payload: nil, request_id: nil, timestamp: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateEvent} for more details.
       #
       #   The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
       #   this shape and varies only in Payload.
       #
-      #   @param event [String, nil] The specific event within the family, for example message.delivered or
+      #   @param event [String, nil] The specific event within the family, for example message.delivered,
       #
-      #   @param field [String] The event family, for example message or templates. Route on this first, then
+      #   @param field [String] The event family, for example message, templates or contact. Route on
       #
       #   @param payload [Sentdm::Models::TemplateEventPayload, nil] Body of a template status event. Delivered when a template's review outcome chan
       #
+      #   @param request_id [String, nil] The event-specific body.
+      #
       #   @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
     end
   end

data/lib/sentdm/models/template_event_payload.rb

@@ -22,6 +22,25 @@ module Sentdm
       #   @return [String, nil]
       optional :account_id, String
 
+      # @!attribute auto_reply_action
+      #   Which consent keyword this template answers, when it is one of Sent's
+      #   auto-replies: OPT_IN, OPT_OUT, HELP, or OTHER for a customer-defined keyword.
+      #
+      #   Omitted for an ordinary template, so its presence is the answer to "is this an
+      #   auto-reply". Sent creates the three compliance auto-replies at signup and they
+      #   go through review like any other template, so their events arrive mixed in with
+      #   the customer's own with nothing else to tell them apart.
+      #
+      #   Named for the reader rather than after Template.OptAction, which it is mapped
+      #   from. The MCP tool result deliberately keeps OptAction, OptKeywords and IsOpt:
+      #   it mirrors the internal shape on purpose and publishes the keywords too, so
+      #   renaming one of the three there would leave a surface half in each vocabulary.
+      #   Two names for one concept, each consistent within its own surface, chosen over a
+      #   rename that breaks MCP clients silently.
+      #
+      #   @return [String, nil]
+      optional :auto_reply_action, String, nil?: true
+
       # @!attribute category
       #   The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
       #
@@ -29,10 +48,16 @@ module Sentdm
       optional :category, String
 
       # @!attribute channel
-      #   The channel the template applies to.
+      #   The channel leg this decision is about, for example whatsapp, sms, or rcs. A
+      #   template is reviewed per channel and the legs come back independently, so each
+      #   one reports separately.
+      #
+      #   Omitted when the decision applies to the template as a whole rather than to one
+      #   leg. That event is the broader news: a template-wide rejection blocks every
+      #   channel, whatever the individual legs say.
       #
       #   @return [String, nil]
-      optional :channel, String
+      optional :channel, String, nil?: true
 
       # @!attribute language
       #   The template's language code, for example en_US.
@@ -59,7 +84,7 @@ module Sentdm
       #   @return [String, nil]
       optional :template_name, String
 
-      # @!method initialize(status:, whatsapp_template_id:, account_id: nil, category: nil, channel: nil, language: nil, reason: nil, template_id: nil, template_name: nil)
+      # @!method initialize(status:, whatsapp_template_id:, account_id: nil, auto_reply_action: nil, category: nil, channel: nil, language: nil, reason: nil, template_id: nil, template_name: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateEventPayload} for more details.
       #
@@ -72,9 +97,11 @@ module Sentdm
       #
       #   @param account_id [String] The account the template belongs to.
       #
+      #   @param auto_reply_action [String, nil] Which consent keyword this template answers, when it is one of Sent's auto-repli
+      #
       #   @param category [String] The template's category, for example UTILITY, MARKETING, or
       #
-      #   @param channel [String] The channel the template applies to.
+      #   @param channel [String, nil] The channel leg this decision is about, for example whatsapp, sms, or rcs.
       #
       #   @param language [String] The template's language code, for example en_US.
       #

data/lib/sentdm/models/template_list_params.rb

@@ -7,18 +7,6 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
-      # @!attribute page
-      #   Page number (1-indexed)
-      #
-      #   @return [Integer]
-      required :page, Integer
-
-      # @!attribute page_size
-      #   Number of items per page
-      #
-      #   @return [Integer]
-      required :page_size, Integer
-
       # @!attribute category
       #   Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
@@ -35,6 +23,18 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :is_welcome_playground, Sentdm::Internal::Type::Boolean, nil?: true
 
+      # @!attribute page
+      #   Page number (1-indexed)
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute page_size
+      #   Number of items per page
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
       # @!attribute search
       #   Optional search term for filtering templates
       #
@@ -52,18 +52,18 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(page:, page_size:, category: nil, is_welcome_playground: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(category: nil, is_welcome_playground: nil, page: nil, page_size: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateListParams} for more details.
       #
-      #   @param page [Integer] Page number (1-indexed)
-      #
-      #   @param page_size [Integer] Number of items per page
-      #
       #   @param category [String, nil] Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
       #   @param is_welcome_playground [Boolean, nil] Accepted and ignored. It used to filter on the welcome-playground marker inside
       #
+      #   @param page [Integer] Page number (1-indexed)
+      #
+      #   @param page_size [Integer] Number of items per page
+      #
       #   @param search [String, nil] Optional search term for filtering templates
       #
       #   @param status [String, nil] Optional status filter: APPROVED, PENDING, REJECTED

data/lib/sentdm/models/template_variable.rb

@@ -4,6 +4,9 @@ module Sentdm
   module Models
     class TemplateVariable < Sentdm::Internal::Type::BaseModel
       # @!attribute name
+      #   The variable's name, and the key callers use for it in a send request's
+      #   parameters object. Must start with a letter and hold only letters, digits and
+      #   underscores.
       #
       #   @return [String]
       required :name, String
@@ -14,20 +17,34 @@ module Sentdm
       required :props, -> { Sentdm::TemplateVariable::Props }
 
       # @!attribute type
+      #   One of variable, link or media. Decides which Props fields are required.
       #
       #   @return [String]
       required :type, String
 
       # @!attribute id
+      #   The variable's index, and the number its {{index:variable}} placeholder refers
+      #   to.
+      #
+      #   Omitting it is only safe for a section holding a single variable. The field is a
+      #   non-nullable int, so every variable that leaves it out defaults to 0, and a
+      #   section with two such variables is refused by the unique-id rule ("variables
+      #   must have unique IDs"). Number them from 0 in the order they appear.
       #
       #   @return [Integer, nil]
       optional :id, Integer
 
       # @!method initialize(name:, props:, type:, id: nil)
-      #   @param name [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateVariable} for more details.
+      #
+      #   @param name [String] The variable's name, and the key callers use for it in a send request's paramete
+      #
       #   @param props [Sentdm::Models::TemplateVariable::Props]
-      #   @param type [String]
-      #   @param id [Integer]
+      #
+      #   @param type [String] One of variable, link or media. Decides which Props fields
+      #
+      #   @param id [Integer] The variable's index, and the number its {{index:variable}} placeholder refers t
 
       # @see Sentdm::Models::TemplateVariable#props
       class Props < Sentdm::Internal::Type::BaseModel

data/lib/sentdm/models/webhook_list_events_params.rb

@@ -14,13 +14,13 @@ module Sentdm
 
       # @!attribute page
       #
-      #   @return [Integer]
-      required :page, Integer
+      #   @return [Integer, nil]
+      optional :page, Integer
 
       # @!attribute page_size
       #
-      #   @return [Integer]
-      required :page_size, Integer
+      #   @return [Integer, nil]
+      optional :page_size, Integer
 
       # @!attribute search
       #
@@ -32,7 +32,7 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(id:, page:, page_size:, search: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(id:, page: nil, page_size: nil, search: nil, x_profile_id: nil, request_options: {})
       #   @param id [String]
       #   @param page [Integer]
       #   @param page_size [Integer]