sentdm 0.45.0 → 0.46.0

data/lib/sentdm/resources/channels.rb

@@ -2,7 +2,124 @@
 
 module Sentdm
   module Resources
+    # The senders you send from, one per channel.
+    #
+    # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+    # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+    # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+    # single**: a customer has one business account and one agent. **Voice is per
+    # number**: each number you hold can carry phone calls on its own
+    # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+    # with its calls, one of them is the default line for calls placed from your app,
+    # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+    # numbers with `GET /v3/channels/voice` and change one with
+    # `PATCH /v3/channels/voice/{number}`.
+    #
+    # ## Compliance lives on the market
+    #
+    # Adding a market records everything that market registers with, in its
+    # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+    # Campaign Registry — and it is the only market whose compliance carries `brand`
+    # and `campaign`. Everywhere else compliance is documents, and many markets ask
+    # for none at all.
+    #
+    # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+    # back can be sent back: an omitted key is left alone, and a key reported in
+    # `requirements` is the path into the body that clears it.
+    #
+    # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+    # before you hold it, with a body you can fill in and post.
     class Channels
+      # The senders you send from, one per channel.
+      #
+      # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+      # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+      # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+      # single**: a customer has one business account and one agent. **Voice is per
+      # number**: each number you hold can carry phone calls on its own
+      # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+      # with its calls, one of them is the default line for calls placed from your app,
+      # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+      # numbers with `GET /v3/channels/voice` and change one with
+      # `PATCH /v3/channels/voice/{number}`.
+      #
+      # ## Compliance lives on the market
+      #
+      # Adding a market records everything that market registers with, in its
+      # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+      # Campaign Registry — and it is the only market whose compliance carries `brand`
+      # and `campaign`. Everywhere else compliance is documents, and many markets ask
+      # for none at all.
+      #
+      # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+      # back can be sent back: an omitted key is left alone, and a key reported in
+      # `requirements` is the path into the body that clears it.
+      #
+      # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+      # before you hold it, with a body you can fill in and post.
+      # @return [Sentdm::Resources::Channels::SMS]
+      attr_reader :sms
+
+      # The senders you send from, one per channel.
+      #
+      # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+      # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+      # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+      # single**: a customer has one business account and one agent. **Voice is per
+      # number**: each number you hold can carry phone calls on its own
+      # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+      # with its calls, one of them is the default line for calls placed from your app,
+      # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+      # numbers with `GET /v3/channels/voice` and change one with
+      # `PATCH /v3/channels/voice/{number}`.
+      #
+      # ## Compliance lives on the market
+      #
+      # Adding a market records everything that market registers with, in its
+      # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+      # Campaign Registry — and it is the only market whose compliance carries `brand`
+      # and `campaign`. Everywhere else compliance is documents, and many markets ask
+      # for none at all.
+      #
+      # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+      # back can be sent back: an omitted key is left alone, and a key reported in
+      # `requirements` is the path into the body that clears it.
+      #
+      # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+      # before you hold it, with a body you can fill in and post.
+      # @return [Sentdm::Resources::Channels::Rcs]
+      attr_reader :rcs
+
+      # The senders you send from, one per channel.
+      #
+      # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+      # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+      # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+      # single**: a customer has one business account and one agent. **Voice is per
+      # number**: each number you hold can carry phone calls on its own
+      # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+      # with its calls, one of them is the default line for calls placed from your app,
+      # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+      # numbers with `GET /v3/channels/voice` and change one with
+      # `PATCH /v3/channels/voice/{number}`.
+      #
+      # ## Compliance lives on the market
+      #
+      # Adding a market records everything that market registers with, in its
+      # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+      # Campaign Registry — and it is the only market whose compliance carries `brand`
+      # and `campaign`. Everywhere else compliance is documents, and many markets ask
+      # for none at all.
+      #
+      # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+      # back can be sent back: an omitted key is left alone, and a key reported in
+      # `requirements` is the path into the body that clears it.
+      #
+      # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+      # before you hold it, with a body you can fill in and post.
+      # @return [Sentdm::Resources::Channels::Whatsapp]
+      attr_reader :whatsapp
+
       # The senders you send from, one per channel.
       #
       # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
@@ -33,11 +150,56 @@ module Sentdm
       # @return [Sentdm::Resources::Channels::Voice]
       attr_reader :voice
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ChannelListParams} for more details.
+      #
+      # Every market you send SMS in, your WhatsApp account, your RCS agent and the
+      # numbers you carry phone calls on — with each one's status, and what each market
+      # has supplied.
+      #
+      # **Status lives on the channel, never on you or your brand.** An identity has no
+      # lifecycle; what has one is the registration of a sender in a market and the
+      # approval of a channel. So a customer live in one country and mid-registration in
+      # another reports exactly that, rather than one flattened answer.
+      #
+      # `sms[n].compliance` carries what each market holds: `brand` and `campaign` for
+      # markets that register with a compliance regime such as US TEN_DLC, and
+      # `documents` for markets that pre-register an alphanumeric or similar sender.
+      # Absent means the market registers with nobody and nothing has been supplied.
+      # `GET /v3/compliance/requirements` says what a market demands of any new
+      # customer; this says what you gave it.
+      #
+      # Send `x-profile-id` with an organization key to read one of your profiles'
+      # channels.
+      #
+      # @overload list(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfChannelsState]
+      #
+      # @see Sentdm::Models::ChannelListParams
+      def list(params = {})
+        parsed, options = Sentdm::ChannelListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v3/channels",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::APIResponseOfChannelsState,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Sentdm::Client]
       def initialize(client:)
         @client = client
+        @sms = Sentdm::Resources::Channels::SMS.new(client: client)
+        @rcs = Sentdm::Resources::Channels::Rcs.new(client: client)
+        @whatsapp = Sentdm::Resources::Channels::Whatsapp.new(client: client)
         @voice = Sentdm::Resources::Channels::Voice.new(client: client)
       end
     end

data/lib/sentdm/resources/compliance.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    # What a market demands, before you have it.
+    #
+    # Requirements vary enormously and change without notice. US `TEN_DLC` registers a
+    # brand and a campaign with The Campaign Registry and asks a substantial set of
+    # questions; an alphanumeric sender pre-registers with documents in one country
+    # and needs nothing in another.
+    #
+    # This is the authoritative answer for whichever market you ask about, and it is
+    # generated from the same declaration that validates the calls themselves — so it
+    # cannot drift from what is actually enforced. The response includes the request
+    # body to send, with every key that market wants already present and blank.
+    #
+    # What you supplied, as opposed to what is asked of you, is reported on the market
+    # under **Channels**.
+    class Compliance
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ComplianceRetrieveRequirementsParams} for more details.
+      #
+      # **Call this first.** It returns what a channel, country and sender type demand
+      # before you can send there — and `setup[]`, the calls that satisfy those demands,
+      # in order, each with a body you can copy and send as it stands. You never have to
+      # track forty countries' rules yourself.
+      #
+      # ## Channel
+      #
+      # `channel` is `sms`, `whatsapp` or `rcs`, and **defaults to `sms`** — so a caller
+      # that omits it gets exactly what this endpoint has always returned.
+      #
+      # `sms` is the only one answered today; the other two are `501` until their
+      # requirements are declared. They are refused rather than answered with an empty
+      # requirement set, because empty would say the channel demands nothing, and both
+      # demand plenty — WhatsApp a business verification and a display name review, RCS
+      # a carrier approval. Saying "not yet" is the true answer and the same one
+      # `POST /v3/sender-profiles` gives for `channels.whatsapp`.
+      #
+      # `type` is an SMS sender type, and SMS is the only channel whose senders have
+      # one.
+      #
+      # Requirements vary enormously. US `TEN_DLC` registers a brand and a campaign with
+      # The Campaign Registry and asks for a substantial set of values. An alphanumeric
+      # sender in one country pre-registers with supporting documents; in another it
+      # needs nothing at all. This is the authoritative answer for whichever market you
+      # are asking about, and it is the same declaration used to validate the calls
+      # themselves — so it can never drift from what is actually enforced.
+      #
+      # ## `setup[]` — what to do
+      #
+      # **One step.** `POST /v3/channels/sms` adds the market and records everything it
+      # registers with — the identity in `compliance.brand`, the programme in
+      # `compliance.campaign`. There were three, in a load-bearing order, while the
+      # identity and the campaign were resources of their own; they are members of this
+      # call's body now, so there is nothing to sequence.
+      #
+      # Correct any of it afterwards with `PATCH /v3/channels/sms/{country}/{type}`,
+      # which takes the same `compliance` object one key at a time.
+      #
+      # Each step's `body` has every key that market wants already present, with the
+      # values left **blank**. Blank rather than filled with placeholders, because the
+      # body is meant to be sent: a null value counts as not supplied, so posting a step
+      # verbatim comes back naming every blank you left. `attachments[]` lists files to
+      # send as multipart on the channel call, each under the field name given — a file
+      # cannot be a JSON value, so documents are never listed in `compliance[]`.
+      #
+      # Every step is a call for whoever holds the key. To set a **sender profile** up
+      # instead, send the same requests with the `x-profile-id` header naming it; there
+      # is no separate path.
+      #
+      # ## `requirements[]` — what each value means
+      #
+      # Each entry names a key for the `compliance` array, its value type, and whether
+      # it is required. `required_when` marks values needed only in certain cases —
+      # evaluate it against your own payload, e.g. `brand.entity_type == PUBLIC_PROFIT`.
+      # `options` lists accepted values where the market constrains them, and `label` is
+      # suitable for rendering a form field.
+      #
+      # Values Sent supplies on your behalf are never listed: correlation ids,
+      # environment flags, carrier elections, and booleans derivable from what you
+      # already send.
+      #
+      # ## When nothing is required
+      #
+      # `required` is `false` and `requirements` is empty, and the single `setup` step
+      # carries no `compliance` array at all. A `sender_id_pattern` may still be present
+      # — many markets constrain the sender string without registering anything.
+      #
+      # @overload retrieve_requirements(channel: nil, country: nil, type: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param channel [String, nil] Query param: Channel the sender is for: sms, whatsapp or rcs. Defaults to sms, w
+      #
+      # @param country [String, nil] Query param: ISO 3166-1 alpha-2 country code, e.g. US, XK, IN
+      #
+      # @param type [String, nil] Query param: Sender type: LOCAL, MOBILE, TEN_DLC, TOLL_FREE, SHORT_CODE, ALPHANU
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfComplianceRequirements]
+      #
+      # @see Sentdm::Models::ComplianceRetrieveRequirementsParams
+      def retrieve_requirements(params = {})
+        query_params = [:channel, :country, :type]
+        parsed, options = Sentdm::ComplianceRetrieveRequirementsParams.dump_request(params)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :get,
+          path: "v3/compliance/requirements",
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::APIResponseOfComplianceRequirements,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/sentdm/resources/conversations.rb

@@ -27,7 +27,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Internal::ConversationsPage<Sentdm::Models::ConversationMessagesList::Message>]
+      # @return [Sentdm::Internal::ConversationsPage<Sentdm::Models::Message>]
       #
       # @see Sentdm::Models::ConversationListParams
       def list(params = {})
@@ -40,7 +40,7 @@ module Sentdm
           query: query,
           headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           page: Sentdm::Internal::ConversationsPage,
-          model: Sentdm::ConversationMessagesList::Message,
+          model: Sentdm::Message,
           options: options
         )
       end
@@ -63,7 +63,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Internal::ConversationsPage<Sentdm::Models::ConversationMessagesList::Message>]
+      # @return [Sentdm::Internal::ConversationsPage<Sentdm::Models::Message>]
       #
       # @see Sentdm::Models::ConversationListMessagesParams
       def list_messages(id, params = {})
@@ -76,7 +76,7 @@ module Sentdm
           query: query,
           headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           page: Sentdm::Internal::ConversationsPage,
-          model: Sentdm::ConversationMessagesList::Message,
+          model: Sentdm::Message,
           options: options
         )
       end

data/lib/sentdm/resources/me.rb

@@ -50,7 +50,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::MeRetrieveResponse]
+      # @return [Sentdm::Models::APIResponseOfAccount]
       #
       # @see Sentdm::Models::MeRetrieveParams
       def retrieve(params = {})
@@ -59,7 +59,7 @@ module Sentdm
           method: :get,
           path: "v3/me",
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::MeRetrieveResponse,
+          model: Sentdm::APIResponseOfAccount,
           options: options
         )
       end

data/lib/sentdm/resources/messages.rb

@@ -25,6 +25,71 @@ module Sentdm
     # released yet. Cancelling is free, fires `message.cancelled`, and is final — a
     # cancelled message cannot be resent.
     class Messages
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MessageCancelParams} for more details.
+      #
+      # Calls off a message you scheduled with `scheduled_at`, before it is released for
+      # sending. The message moves to `CANCELLED`, which is terminal, and it is never
+      # sent.
+      #
+      # **Only a SCHEDULED message can be cancelled.** A message that has already been
+      # released — queued, in flight, or finished — returns 409. The release sweeper
+      # runs continuously, so a cancellation sent within about a minute of the scheduled
+      # instant can lose that race and be refused; cancel with time to spare.
+      #
+      # **One message per call.** A send to many recipients, or on several channels,
+      # becomes one message per recipient × channel, each with its own id; cancel the
+      # ones you want stopped. There is no bulk cancellation.
+      #
+      # **Cancelling is free**, and nothing was charged for the hold in the first place
+      # — a scheduled message is only priced and billed at release.
+      #
+      # **A cancellation fires `message.cancelled`** on your webhook, exactly once,
+      # carrying the `scheduled_at` that was called off so a consumer can un-record the
+      # send it was expecting. Cancelling the same message again returns this same
+      # response and fires no second event. `Idempotency-Key` is honoured.
+      #
+      # A cancelled message cannot be resent — send a new one.
+      #
+      # The response is the message itself, in the same shape `GET /v3/messages/{id}`
+      # returns, so the `status` you read back is the one now stored on the row, and
+      # `scheduled_at` is the time it would have gone out. `GET /v3/messages/{id}` keeps
+      # reporting both afterwards.
+      #
+      # `events` is the message lifecycle as it stood immediately before the
+      # cancellation: the CANCELLED entry is written asynchronously and lands a moment
+      # later, so read `status` for the outcome. If you need the entry itself, re-fetch
+      # the message after a few seconds — `GET /v3/messages/{id}` is cached briefly, so
+      # an immediate re-fetch can still show the pre-cancellation state.
+      #
+      # @overload cancel(id, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param id [String] Path param: Message ID
+      #
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
+      #
+      # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfCancelledMessage]
+      #
+      # @see Sentdm::Models::MessageCancelParams
+      def cancel(id, params = {})
+        parsed, options = Sentdm::MessageCancelParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
+        @client.request(
+          method: :post,
+          path: ["v3/messages/%1$s/cancel", id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Sentdm::APIResponseOfCancelledMessage,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Sentdm::Models::MessageResendParams} for more details.
       #
@@ -102,7 +167,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::MessageRetrieveActivitiesResponse]
+      # @return [Sentdm::Models::APIResponseOfMessageActivities]
       #
       # @see Sentdm::Models::MessageRetrieveActivitiesParams
       def retrieve_activities(id, params = {})
@@ -111,7 +176,7 @@ module Sentdm
           method: :get,
           path: ["v3/messages/%1$s/activities", id],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::MessageRetrieveActivitiesResponse,
+          model: Sentdm::APIResponseOfMessageActivities,
           options: options
         )
       end
@@ -135,7 +200,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::MessageRetrieveStatusResponse]
+      # @return [Sentdm::Models::APIResponseOfMessage]
       #
       # @see Sentdm::Models::MessageRetrieveStatusParams
       def retrieve_status(id, params = {})
@@ -144,7 +209,7 @@ module Sentdm
           method: :get,
           path: ["v3/messages/%1$s", id],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::MessageRetrieveStatusResponse,
+          model: Sentdm::APIResponseOfMessage,
           options: options
         )
       end
@@ -192,7 +257,7 @@ module Sentdm
       #
       # @param channel [Array<String>, nil] Body param: Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
-      # @param channels [Hash{Symbol=>Array<Sentdm::Models::MessageSendParams::Channel>}, nil] Body param: Which of your own numbers to send from, keyed by channel, each chann
+      # @param channels [Hash{Symbol=>Array<Sentdm::Models::MessageChannelOptions>}, nil] Body param: Which of your own numbers to send from, keyed by channel, each chann
       #
       # @param media_urls [Array<String>, nil] Body param: Attachments for this send, as publicly fetchable https URLs. Used by
       #
@@ -202,7 +267,7 @@ module Sentdm
       #
       # @param subject [String, nil] Body param: Subject line for this send, overriding the template's. MMS only; ign
       #
-      # @param template [Sentdm::Models::MessageSendParams::Template, nil] Body param: SDK-style template reference: resolve by ID or by name, with optiona
+      # @param template [Sentdm::Models::TemplateRef, nil] Body param: SDK-style template reference: resolve by ID or by name, with optiona
       #
       # @param text [String, nil] Body param: Plain-text (free-form) message body. Provide either Template or this
       #

data/lib/sentdm/resources/numbers.rb

@@ -24,7 +24,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::NumberLookupResponse]
+      # @return [Sentdm::Models::APIResponseOfNumberLookupResult]
       #
       # @see Sentdm::Models::NumberLookupParams
       def lookup(phone_number, params = {})
@@ -33,7 +33,7 @@ module Sentdm
           method: :get,
           path: ["v3/numbers/lookup/%1$s", phone_number],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::NumberLookupResponse,
+          model: Sentdm::APIResponseOfNumberLookupResult,
           options: options
         )
       end

data/lib/sentdm/resources/profiles.rb

@@ -285,7 +285,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::ProfileListResponse]
+      # @return [Sentdm::Models::APIResponseOfProfilesList]
       #
       # @see Sentdm::Models::ProfileListParams
       def list(params = {})
@@ -294,7 +294,7 @@ module Sentdm
           method: :get,
           path: "v3/profiles",
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::Models::ProfileListResponse,
+          model: Sentdm::APIResponseOfProfilesList,
           options: options
         )
       end
@@ -412,7 +412,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::ProfileCompleteResponse]
+      # @return [Sentdm::Models::APIResponseOfProfileCompletionResult]
       #
       # @see Sentdm::Models::ProfileCompleteParams
       def complete(profile_id, params)
@@ -423,7 +423,7 @@ module Sentdm
           path: ["v3/profiles/%1$s/complete", profile_id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::Models::ProfileCompleteResponse,
+          model: Sentdm::APIResponseOfProfileCompletionResult,
           options: options
         )
       end