sentdm 0.44.0 → 0.46.0

data/lib/sentdm/models/link_event_payload.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class LinkEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute record_id
+      #   The link's public identifier — the eight-character code in the short URL, for
+      #   example A78B2BU0. Unique across both kinds, and never reused, so it is the
+      #   stable key to group one link's events by.
+      #
+      #   @return [String]
+      required :record_id, String
+
+      # @!attribute access_country
+      #   Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named
+      #   separately from the country on a channel event, which is a destination market
+      #   the customer registered for — this one is a property of a single visitor and is
+      #   absent when the edge could not resolve it.
+      #
+      #   @return [String, nil]
+      optional :access_country, String, nil?: true
+
+      # @!attribute access_outcome
+      #   How the request was served, when the edge recorded it. Free text describing the
+      #   outcome — show it to a human rather than branching on it.
+      #
+      #   @return [String, nil]
+      optional :access_outcome, String, nil?: true
+
+      # @!attribute browser
+      #   The requesting browser family, for example chrome or safari, or unknown. Derived
+      #   from the user agent.
+      #
+      #   @return [String, nil]
+      optional :browser, String, nil?: true
+
+      # @!attribute bytes_served
+      #   How many bytes were served, for a file access. A ranged request reports the
+      #   bytes in that range, not the size of the file, so several accesses of one file
+      #   can each report a part.
+      #
+      #   @return [Integer, nil]
+      optional :bytes_served, Integer, nil?: true
+
+      # @!attribute channel
+      #   The channel the message carrying this link went out on: sms, whatsapp, or rcs.
+      #
+      #   @return [String, nil]
+      optional :channel, String, nil?: true
+
+      # @!attribute customer_id
+      #   The organization the link belongs to. Always the parent account, never a sender
+      #   profile — read SenderProfileId for that.
+      #
+      #   This family publishes the owner as an explicit pair rather than the single
+      #   account_id the other families use. The pair says which organization and which
+      #   profile without the subscriber deriving either, which is the trade: one more key
+      #   against not having to know that account_id silently becomes the profile when one
+      #   exists.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String
+
+      # @!attribute device
+      #   The requesting device class: mobile, tablet, desktop or unknown. Derived from
+      #   the user agent.
+      #
+      #   @return [String, nil]
+      optional :device, String, nil?: true
+
+      # @!attribute link_kind
+      #   What the link points at: url for a destination the customer supplied, file for
+      #   media Sent hosts. Always present, and implied by the event — link.clicked is
+      #   always url and link.downloaded always file — but published as its own field so a
+      #   subscriber can branch on the kind without parsing the event name, the same
+      #   separation the channel family keeps between its event and its status.
+      #
+      #   @return [String, nil]
+      optional :link_kind, String
+
+      # @!attribute message_id
+      #   The message the link was published in.
+      #
+      #   The event can arrive before the message is readable through GET /v3/messages: a
+      #   provider may fetch a link within milliseconds of the send, and nothing here
+      #   waits for the message row. Retry the read rather than treating an unknown id as
+      #   an error.
+      #
+      #   @return [String, nil]
+      optional :message_id, String, nil?: true
+
+      # @!attribute occurred_at
+      #   When the access or lifecycle change actually happened, in UTC
+      #   (yyyy-MM-ddTHH:mm:ssZ). The envelope's timestamp is when Sent emitted the event;
+      #   this is when the thing occurred, and the two differ by the ingest delay.
+      #
+      #   @return [String, nil]
+      optional :occurred_at, String
+
+      # @!attribute reference_key
+      #   The caller-supplied label tying this link back to a position in the message, for
+      #   example body:0 for the first link in the body. Present when the link was created
+      #   with one.
+      #
+      #   @return [String, nil]
+      optional :reference_key, String, nil?: true
+
+      # @!attribute referrer_host
+      #   The host of the page that linked here, when the request supplied one. The host
+      #   only — never a full referring URL.
+      #
+      #   @return [String, nil]
+      optional :referrer_host, String, nil?: true
+
+      # @!attribute request_method
+      #   The HTTP method of the request that was served, for an access event. Omitted on
+      #   link.expired and link.revoked, which describe no request.
+      #
+      #   @return [String, nil]
+      optional :request_method, String, nil?: true
+
+      # @!attribute sender_profile_id
+      #   The sender profile that owns the link, or null when the organization owns it
+      #   directly. Always on the wire so a handler reads one shape rather than branching
+      #   on whether the key arrived.
+      #
+      #   sender_profile_id, not profile_id: the API already publishes
+      #   messaging_profile_id and sending_phone_number_profile_id for provider-side
+      #   profiles, which are a different thing entirely. The unqualified name would read
+      #   as one of those.
+      #
+      #   @return [String, nil]
+      optional :sender_profile_id, String, nil?: true
+
+      # @!attribute status_code
+      #   The HTTP status Sent answered the request with: 302 for a link, 200 or 206 for a
+      #   file. Omitted on lifecycle events.
+      #
+      #   @return [Integer, nil]
+      optional :status_code, Integer, nil?: true
+
+      # @!attribute traffic_class
+      #   A coarse guess at what made the request: likely_human, provider (a messaging
+      #   platform prefetching the link), bot, or unknown. Derived from the user agent, so
+      #   it is a hint for filtering noise rather than a fact to bill or report on.
+      #
+      #   @return [String, nil]
+      optional :traffic_class, String, nil?: true
+
+      # @!method initialize(record_id:, access_country: nil, access_outcome: nil, browser: nil, bytes_served: nil, channel: nil, customer_id: nil, device: nil, link_kind: nil, message_id: nil, occurred_at: nil, reference_key: nil, referrer_host: nil, request_method: nil, sender_profile_id: nil, status_code: nil, traffic_class: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::LinkEventPayload} for more details.
+      #
+      #   Body of a link event: something happened to a tracked link Sent published on the
+      #   customer's behalf. A link points either at a URL the customer supplied or at a
+      #   file Sent hosts for them; LinkKind says which. Delivered when an eligible
+      #   request is served, or when a published link reaches the end of its life.
+      #
+      #   A click is a request, not a read receipt. link.clicked means the redirect was
+      #   served; link.downloaded means bytes went out. Neither proves a person saw
+      #   anything — messaging providers and link scanners fetch URLs on their own, which
+      #   is what TrafficClass exists to tell apart. Filter on it before reporting a
+      #   click-through rate; treat likely_human as a hint, never as delivery
+      #   confirmation.
+      #
+      #   RecordId identifies the link; the X-Webhook-Event-ID header identifies the
+      #   delivery. One link is hit many times, so those are the two keys a subscriber
+      #   needs: group by the first, deduplicate on the second — exactly as on every other
+      #   family. The payload carries no event identifier of its own, for the same reason
+      #   none of the others do.
+      #
+      #   Nothing here identifies the visitor. No IP address and no visitor token crosses
+      #   this boundary. Country, Device and Browser are coarse buckets derived at the
+      #   edge and are absent whenever the request did not supply enough to derive them.
+      #
+      #   @param record_id [String] The link's public identifier — the eight-character code in the short URL, for ex
+      #
+      #   @param access_country [String, nil] Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named se
+      #
+      #   @param access_outcome [String, nil] How the request was served, when the edge recorded it. Free text describing the
+      #
+      #   @param browser [String, nil] The requesting browser family, for example chrome or safari, or
+      #
+      #   @param bytes_served [Integer, nil] How many bytes were served, for a file access. A ranged request reports the byte
+      #
+      #   @param channel [String, nil] The channel the message carrying this link went out on: sms, whatsapp, or
+      #
+      #   @param customer_id [String] The organization the link belongs to. Always the parent account, never a sender
+      #
+      #   @param device [String, nil] The requesting device class: mobile, tablet, desktop or
+      #
+      #   @param link_kind [String] What the link points at: url for a destination the customer supplied, file for
+      #
+      #   @param message_id [String, nil] The message the link was published in.
+      #
+      #   @param occurred_at [String] When the access or lifecycle change actually happened, in UTC
+      #
+      #   @param reference_key [String, nil] The caller-supplied label tying this link back to a position in the message, for
+      #
+      #   @param referrer_host [String, nil] The host of the page that linked here, when the request supplied one. The host o
+      #
+      #   @param request_method [String, nil] The HTTP method of the request that was served, for an access event. Omitted on
+      #
+      #   @param sender_profile_id [String, nil] The sender profile that owns the link, or null when the organization owns it dir
+      #
+      #   @param status_code [Integer, nil] The HTTP status Sent answered the request with: 302 for a link, 200 or
+      #
+      #   @param traffic_class [String, nil] A coarse guess at what made the request: likely_human, provider (a messaging
+    end
+  end
+end

data/lib/sentdm/models/message.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class Message < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute active_contact_price
+      #
+      #   @return [Float, nil]
+      optional :active_contact_price, Float, nil?: true
+
+      # @!attribute channel
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute contact_id
+      #
+      #   @return [String, nil]
+      optional :contact_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute customer_id
+      #
+      #   @return [String, nil]
+      optional :customer_id, String
+
+      # @!attribute direction
+      #
+      #   @return [String, nil]
+      optional :direction, String
+
+      # @!attribute events
+      #
+      #   @return [Array<Sentdm::Models::MessageStatusEvent>, nil]
+      optional :events, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageStatusEvent] }, nil?: true
+
+      # @!attribute message_body
+      #   Structured message body format for database storage. Preserves channel-specific
+      #   components (header, header media, body, footer, buttons, MMS subject and media).
+      #
+      #   Persisted as the messageBody jsonb column on Messages. Every write path goes
+      #   through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
+      #   shape is stable regardless of channel or status. Anything that rebuilds this
+      #   object field by field — the four IMessageBodyStrategy implementations and
+      #   MessageUtils.BuildSegmentBody — has to carry every member, or that member is
+      #   silently dropped on whichever path forgot it.
+      #
+      #   @return [Sentdm::Models::MessageBody, nil]
+      optional :message_body, -> { Sentdm::MessageBody }, nil?: true
+
+      # @!attribute phone
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!attribute phone_international
+      #
+      #   @return [String, nil]
+      optional :phone_international, String
+
+      # @!attribute price
+      #
+      #   @return [Float, nil]
+      optional :price, Float, nil?: true
+
+      # @!attribute reason
+      #   A human-readable sentence for reason_code, for example "Insufficient balance".
+      #   Omitted whenever reason_code is.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute reason_code
+      #   Why the message is at its current status, as a stable platform code such as
+      #   DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+      #   FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+      #   Switch on this rather than on reason: the code is stable, the wording may be
+      #   improved. It is the platform's classification of the outcome, never a carrier or
+      #   vendor code.
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
+      # @!attribute region_code
+      #
+      #   @return [String, nil]
+      optional :region_code, String
+
+      # @!attribute status
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_category
+      #
+      #   @return [String, nil]
+      optional :template_category, String, nil?: true
+
+      # @!attribute template_id
+      #
+      #   @return [String, nil]
+      optional :template_id, String, nil?: true
+
+      # @!attribute template_name
+      #
+      #   @return [String, nil]
+      optional :template_name, String, nil?: true
+
+      # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, reason: nil, reason_code: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+      #   Some parameter documentations has been truncated, see {Sentdm::Models::Message}
+      #   for more details.
+      #
+      #   Message response for v3 API — same shape as v2 with snake_case JSON conventions.
+      #
+      #   The shape of a message that was sent immediately: it never has a scheduled_at
+      #   key. A message that is or was held for a later instant is a
+      #   ScheduledMessageResponse, and the endpoint decides which of the two to answer
+      #   with. From always returns this type.
+      #
+      #   @param id [String]
+      #
+      #   @param active_contact_price [Float, nil]
+      #
+      #   @param channel [String]
+      #
+      #   @param contact_id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param customer_id [String]
+      #
+      #   @param direction [String]
+      #
+      #   @param events [Array<Sentdm::Models::MessageStatusEvent>, nil]
+      #
+      #   @param message_body [Sentdm::Models::MessageBody, nil] Structured message body format for database storage.
+      #
+      #   @param phone [String]
+      #
+      #   @param phone_international [String]
+      #
+      #   @param price [Float, nil]
+      #
+      #   @param reason [String, nil] A human-readable sentence for reason_code, for example "Insufficient balance". O
+      #
+      #   @param reason_code [String, nil] Why the message is at its current status, as a stable platform code such as
+      #
+      #   @param region_code [String]
+      #
+      #   @param status [String]
+      #
+      #   @param template_category [String, nil]
+      #
+      #   @param template_id [String, nil]
+      #
+      #   @param template_name [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/message_activities.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageActivities < Sentdm::Internal::Type::BaseModel
+      # @!attribute activities
+      #   List of activity events ordered by most recent first
+      #
+      #   @return [Array<Sentdm::Models::MessageActivity>, nil]
+      optional :activities, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageActivity] }
+
+      # @!attribute message_id
+      #   The message ID these activities belong to
+      #
+      #   @return [String, nil]
+      optional :message_id, String
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(activities: nil, message_id: nil, pagination: nil)
+      #   Response for GET /messages/{id}/activities
+      #
+      #   @param activities [Array<Sentdm::Models::MessageActivity>] List of activity events ordered by most recent first
+      #
+      #   @param message_id [String] The message ID these activities belong to
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+    end
+  end
+end

data/lib/sentdm/models/message_activity.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageActivity < Sentdm::Internal::Type::BaseModel
+      # @!attribute active_contact_price
+      #   Active contact markup applied on top of the channel cost, formatted to 4 decimal
+      #   places.
+      #
+      #   @return [String, nil]
+      optional :active_contact_price, String, nil?: true
+
+      # @!attribute description
+      #   Human-readable description of the activity
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute from
+      #   Sender phone number for this activity (the customer's sending number for
+      #   outbound, the external sender for inbound). Null when not reported by the
+      #   provider.
+      #
+      #   @return [String, nil]
+      optional :from, String, nil?: true
+
+      # @!attribute price
+      #   Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+      #   4 decimal places.
+      #
+      #   @return [String, nil]
+      optional :price, String, nil?: true
+
+      # @!attribute reason
+      #   A human-readable sentence for reason_code, for example "The recipient is not
+      #   registered on this channel" Omitted whenever reason_code is.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute reason_code
+      #   Why the message reached this status, as a stable platform code such as
+      #   DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+      #   activities; omitted on every status that needs no explanation. Switch on this
+      #   rather than on reason: the code is stable, the wording may be improved. Same
+      #   wire name and vocabulary as on the message and the webhook.
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
+      # @!attribute scheduled_at
+      #   SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+      #   held message will be released for delivery; on a CANCELLED entry, the instant
+      #   that was called off. Same wire name as on the send response, the message and the
+      #   webhook. Omitted on every other activity. A message that quiet hours moved at
+      #   release has two SCHEDULED entries, each carrying the instant as it stood at that
+      #   moment.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, nil?: true
+
+      # @!attribute status
+      #   Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
+      #   DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute timestamp
+      #   When this activity occurred
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!method initialize(active_contact_price: nil, description: nil, from: nil, price: nil, reason: nil, reason_code: nil, scheduled_at: nil, status: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageActivity} for more details.
+      #
+      #   A single message activity event for v3 API.
+      #
+      #   The activity list mixes statuses, so unlike a message it is one shape rather
+      #   than two: a SCHEDULED entry carries scheduled_at, and every other entry has no
+      #   such key.
+      #
+      #   @param active_contact_price [String, nil] Active contact markup applied on top of the channel cost, formatted to 4 decimal
+      #
+      #   @param description [String] Human-readable description of the activity
+      #
+      #   @param from [String, nil] Sender phone number for this activity (the customer's sending number for outboun
+      #
+      #   @param price [String, nil] Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
+      #
+      #   @param reason [String, nil] A human-readable sentence for reason_code, for example "The recipient is not reg
+      #
+      #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
+      #   DELIVERY\_
+      #
+      #   @param scheduled_at [Time, nil] SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+      #
+      #   @param status [String] Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT, DELIVERED
+      #
+      #   @param timestamp [Time] When this activity occurred
+    end
+  end
+end

data/lib/sentdm/models/message_body.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageBody < Sentdm::Internal::Type::BaseModel
+      # @!attribute buttons
+      #
+      #   @return [Array<Sentdm::Models::MessageButton>, nil]
+      optional :buttons, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageButton] }, nil?: true
+
+      # @!attribute content
+      #
+      #   @return [String, nil]
+      optional :content, String
+
+      # @!attribute footer
+      #
+      #   @return [String, nil]
+      optional :footer, String, nil?: true
+
+      # @!attribute header
+      #
+      #   @return [String, nil]
+      optional :header, String, nil?: true
+
+      # @!attribute header_media
+      #   The media asset that rode a message's header, recorded as sent.
+      #
+      #   @return [Sentdm::Models::MessageHeaderMedia, nil]
+      optional :header_media, -> { Sentdm::MessageHeaderMedia }, api_name: :headerMedia, nil?: true
+
+      # @!attribute media
+      #   MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on
+      #   every other channel.
+      #
+      #   Persisted rather than derived because a resend and a curfew release rebuild the
+      #   send from the stored row — MessageReplayCommandBuilder reads templateId and
+      #   templateVariables and nothing else — so media that lives only on the original
+      #   request would silently turn a replayed MMS into a text message.
+      #
+      #   @return [Array<Sentdm::Models::MessageMedia>, nil]
+      optional :media, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::MessageMedia] }, nil?: true
+
+      # @!attribute subject
+      #   MMS subject line. Null on every other channel.
+      #
+      #   @return [String, nil]
+      optional :subject, String, nil?: true
+
+      # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil, header_media: nil, media: nil, subject: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MessageBody} for more details.
+      #
+      #   Structured message body format for database storage. Preserves channel-specific
+      #   components (header, header media, body, footer, buttons, MMS subject and media).
+      #
+      #   Persisted as the messageBody jsonb column on Messages. Every write path goes
+      #   through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
+      #   shape is stable regardless of channel or status. Anything that rebuilds this
+      #   object field by field — the four IMessageBodyStrategy implementations and
+      #   MessageUtils.BuildSegmentBody — has to carry every member, or that member is
+      #   silently dropped on whichever path forgot it.
+      #
+      #   @param buttons [Array<Sentdm::Models::MessageButton>, nil]
+      #
+      #   @param content [String]
+      #
+      #   @param footer [String, nil]
+      #
+      #   @param header [String, nil]
+      #
+      #   @param header_media [Sentdm::Models::MessageHeaderMedia, nil] The media asset that rode a message's header, recorded as sent.
+      #
+      #   @param media [Array<Sentdm::Models::MessageMedia>, nil] MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on e
+      #
+      #   @param subject [String, nil] MMS subject line. Null on every other channel.
+    end
+  end
+end

data/lib/sentdm/models/message_button.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class MessageButton < Sentdm::Internal::Type::BaseModel
+      # @!attribute postback_data
+      #
+      #   @return [String, nil]
+      optional :postback_data, String, api_name: :postbackData, nil?: true
+
+      # @!attribute text
+      #
+      #   @return [String, nil]
+      optional :text, String, nil?: true
+
+      # @!attribute type
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute value
+      #
+      #   @return [String, nil]
+      optional :value, String
+
+      # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
+      #   @param postback_data [String, nil]
+      #   @param text [String, nil]
+      #   @param type [String]
+      #   @param value [String]
+    end
+  end
+end

data/lib/sentdm/models/message_cancel_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Messages#cancel
+    class MessageCancelParams < Sentdm::Models::MutationRequest
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(id:, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      #   @param id [String]
+      #   @param idempotency_key [String]
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end