sentdm 0.38.1 → 0.40.0

data/lib/sentdm/models/voice/api_response_of_voice_catalogue.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Catalogue#list
+      class APIResponseOfVoiceCatalogue < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The voices and languages a text-session agent may name in its speech settings:
+        #   what GET /v3/voice/voices and the admin GET /voice/voices answer, in one shape.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceCatalogue, nil]
+        optional :data, -> { Sentdm::Voice::VoiceCatalogue }, nil?: true
+
+        # @!attribute error
+        #   Error information
+        #
+        #   @return [Sentdm::Models::ErrorDetail, nil]
+        optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+        # @!attribute meta
+        #   Request and response metadata
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!attribute success
+        #   Indicates whether the request was successful
+        #
+        #   @return [Boolean, nil]
+        optional :success, Sentdm::Internal::Type::Boolean
+
+        # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::APIResponseOfVoiceCatalogue} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceCatalogue, nil] The voices and languages a text-session agent may name in its speech settings: w
+        #
+        #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/{channels → voice}/api_response_of_voice_token.rb

@@ -2,14 +2,14 @@
 
 module Sentdm
   module Models
-    module Channels
-      # @see Sentdm::Resources::Channels::Voice#create_token
+    module Voice
+      # @see Sentdm::Resources::Voice::Tokens#create
       class APIResponseOfVoiceToken < Sentdm::Internal::Type::BaseModel
         # @!attribute data
         #   A short-lived token your app passes to the voice client SDK to register
         #
-        #   @return [Sentdm::Models::Channels::VoiceToken, nil]
-        optional :data, -> { Sentdm::Channels::VoiceToken }, nil?: true
+        #   @return [Sentdm::Models::Voice::VoiceToken, nil]
+        optional :data, -> { Sentdm::Voice::VoiceToken }, nil?: true
 
         # @!attribute error
         #   Error information
@@ -32,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Sentdm::Models::Channels::VoiceToken, nil] A short-lived token your app passes to the voice client SDK to register
+        #   @param data [Sentdm::Models::Voice::VoiceToken, nil] A short-lived token your app passes to the voice client SDK to register
         #
         #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
         #

data/lib/sentdm/models/voice/call.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#list
+      class Call < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   The call id, the same one carried by the call.request question and every call
+        #   webhook
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute agent_id
+        #   The voice agent that answered the call, such as
+        #   agent_9f2ab000-0000-4000-8000-000000000001. Null for an inapp call
+        #
+        #   @return [String, nil]
+        optional :agent_id, String, nil?: true
+
+        # @!attribute answered_at
+        #   When the call was answered (UTC). Null until then, and always null for a call
+        #   between two of your app users
+        #
+        #   @return [Time, nil]
+        optional :answered_at, Time, nil?: true
+
+        # @!attribute caller_id_used
+        #   The caller id shown on the phone leg, in E.164 format: the one your answer
+        #   chose, or the owning number when it chose none. Null for a call with no phone
+        #   leg
+        #
+        #   @return [String, nil]
+        optional :caller_id_used, String, nil?: true
+
+        # @!attribute connected_number
+        #   The phone number the call was connected to, in E.164 format: the number your
+        #   answer dialed, or the fallback number a call to one of your voice agents
+        #   reached. Null when the call was not connected to a phone number
+        #
+        #   @return [String, nil]
+        optional :connected_number, String, nil?: true
+
+        # @!attribute direction
+        #   outbound for a call placed from your app, inbound for a call to one of your
+        #   numbers
+        #
+        #   @return [String, nil]
+        optional :direction, String
+
+        # @!attribute duration_seconds
+        #   Billable duration in seconds. Null while the call is live
+        #
+        #   @return [Integer, nil]
+        optional :duration_seconds, Integer, nil?: true
+
+        # @!attribute ended_at
+        #   When the call ended (UTC). Null while the call is live
+        #
+        #   @return [Time, nil]
+        optional :ended_at, Time, nil?: true
+
+        # @!attribute failure_reason
+        #   Why the call did not complete: callback_timeout, invalid_answer,
+        #   insufficient_balance, destination_blocked, callback_not_configured, rejected,
+        #   no_answer, or for an agent call agent_busy or agent_unreachable. Null while the
+        #   call is live, when it completed, and when it failed without a recorded reason
+        #
+        #   @return [String, nil]
+        optional :failure_reason, String, nil?: true
+
+        # @!attribute from
+        #   One end of a call
+        #
+        #   @return [Sentdm::Models::Voice::CallParty, nil]
+        optional :from, -> { Sentdm::Voice::CallParty }
+
+        # @!attribute legs
+        #   The legs the price covers, one entry per billed leg, each with its own cost: a
+        #   call your answer connected to a phone number ran the caller's leg to your number
+        #   and the leg to the connected number at once, and both are billed. Null until the
+        #   call has been priced
+        #
+        #   @return [Array<Sentdm::Models::Voice::Call::Leg>, nil]
+        optional :legs, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::Call::Leg] }, nil?: true
+
+        # @!attribute mode
+        #   The calling mode: inapp for a call between people in your app and phone numbers,
+        #   routed by your number's callback URL; agent for a call one of your voice agents
+        #   answered
+        #
+        #   @return [String, nil]
+        optional :mode, String
+
+        # @!attribute number
+        #   Your number that owns the call, in E.164 format: the dialed number for an
+        #   inbound call, the caller's bound number for a call placed from your app
+        #
+        #   @return [String, nil]
+        optional :number, String
+
+        # @!attribute price
+        #   What the call cost. Null until it has been priced
+        #
+        #   @return [Float, nil]
+        optional :price, Float, nil?: true
+
+        # @!attribute recording_available
+        #   True once a recording of the call is available
+        #
+        #   @return [Boolean, nil]
+        optional :recording_available, Sentdm::Internal::Type::Boolean
+
+        # @!attribute started_at
+        #   When the call was placed (UTC)
+        #
+        #   @return [Time, nil]
+        optional :started_at, Time
+
+        # @!attribute status
+        #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute timeline
+        #   When the call entered each status, oldest first. Only returned when reading one
+        #   call
+        #
+        #   @return [Array<Sentdm::Models::Voice::CallTimelineEntry>, nil]
+        optional :timeline,
+                 -> {
+                   Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::CallTimelineEntry]
+                 },
+                 nil?: true
+
+        # @!attribute to
+        #   One end of a call
+        #
+        #   @return [Sentdm::Models::Voice::CallParty, nil]
+        optional :to, -> { Sentdm::Voice::CallParty }
+
+        # @!method initialize(id: nil, agent_id: nil, answered_at: nil, caller_id_used: nil, connected_number: nil, direction: nil, duration_seconds: nil, ended_at: nil, failure_reason: nil, from: nil, legs: nil, mode: nil, number: nil, price: nil, recording_available: nil, started_at: nil, status: nil, timeline: nil, to: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::Call} for more details.
+        #
+        #   A call record
+        #
+        #   @param id [String] The call id, the same one carried by the call.request question and every call we
+        #
+        #   @param agent_id [String, nil] The voice agent that answered the call, such as agent_9f2ab000-0000-4000-8000-00
+        #
+        #   @param answered_at [Time, nil] When the call was answered (UTC). Null until then, and always null for a call be
+        #
+        #   @param caller_id_used [String, nil] The caller id shown on the phone leg, in E.164 format: the one your answer chose
+        #
+        #   @param connected_number [String, nil] The phone number the call was connected to, in E.164 format: the number your ans
+        #
+        #   @param direction [String] outbound for a call placed from your app, inbound for a call to one of your numb
+        #
+        #   @param duration_seconds [Integer, nil] Billable duration in seconds. Null while the call is live
+        #
+        #   @param ended_at [Time, nil] When the call ended (UTC). Null while the call is live
+        #
+        #   @param failure_reason [String, nil] Why the call did not complete: callback_timeout, invalid_answer, insufficient_ba
+        #
+        #   @param from [Sentdm::Models::Voice::CallParty] One end of a call
+        #
+        #   @param legs [Array<Sentdm::Models::Voice::Call::Leg>, nil] The legs the price covers, one entry per billed leg, each with its own cost: a c
+        #
+        #   @param mode [String] The calling mode: inapp for a call between people in your app and phone numbers,
+        #
+        #   @param number [String] Your number that owns the call, in E.164 format: the dialed number for an inboun
+        #
+        #   @param price [Float, nil] What the call cost. Null until it has been priced
+        #
+        #   @param recording_available [Boolean] True once a recording of the call is available
+        #
+        #   @param started_at [Time] When the call was placed (UTC)
+        #
+        #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @param timeline [Array<Sentdm::Models::Voice::CallTimelineEntry>, nil] When the call entered each status, oldest first. Only returned when reading one
+        #
+        #   @param to [Sentdm::Models::Voice::CallParty] One end of a call
+
+        class Leg < Sentdm::Internal::Type::BaseModel
+          # @!attribute billed_minutes
+          #   The whole minutes the leg was billed for
+          #
+          #   @return [Integer, nil]
+          optional :billed_minutes, Integer
+
+          # @!attribute cost
+          #   What the leg cost, in the same unit as the call's price
+          #
+          #   @return [Float, nil]
+          optional :cost, Float
+
+          # @!attribute currency
+          #   The currency of the cost: USD
+          #
+          #   @return [String, nil]
+          optional :currency, String
+
+          # @!attribute direction
+          #   inbound for the caller's leg to your number, outbound for a leg placed on your
+          #   behalf
+          #
+          #   @return [String, nil]
+          optional :direction, String
+
+          # @!attribute number
+          #   The phone number the leg reached, in E.164 format: your number for the inbound
+          #   leg, the number dialed for an outbound one. Null for a leg to one of your app
+          #   users or a room
+          #
+          #   @return [String, nil]
+          optional :number, String, nil?: true
+
+          # @!method initialize(billed_minutes: nil, cost: nil, currency: nil, direction: nil, number: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Call::Leg} for more details.
+          #
+          #   One leg of a call the price covers
+          #
+          #   @param billed_minutes [Integer] The whole minutes the leg was billed for
+          #
+          #   @param cost [Float] What the leg cost, in the same unit as the call's price
+          #
+          #   @param currency [String] The currency of the cost: USD
+          #
+          #   @param direction [String] inbound for the caller's leg to your number, outbound for a leg placed on your b
+          #
+          #   @param number [String, nil] The phone number the leg reached, in E.164 format: your number for the inbound l
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/{calls/participant_remove_params.rb → voice/call_hangup_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#remove
-      class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#hangup
+      class CallHangupParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -13,19 +13,19 @@ module Sentdm
         #   @return [String]
         required :id, String
 
-        # @!attribute participant_id
+        # @!attribute idempotency_key
         #
-        #   @return [String]
-        required :participant_id, String
+        #   @return [String, nil]
+        optional :idempotency_key, String
 
         # @!attribute x_profile_id
         #
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(id:, participant_id:, x_profile_id: nil, request_options: {})
+        # @!method initialize(id:, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #   @param id [String]
-        #   @param participant_id [String]
+        #   @param idempotency_key [String]
         #   @param x_profile_id [String]
         #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/sentdm/models/voice/call_list_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#list
+      class CallListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute agent_id
+        #   Optional filter on the voice agent that answered the call, such as
+        #   agent_9f2ab000-0000-4000-8000-000000000001
+        #
+        #   @return [String, nil]
+        optional :agent_id, String, nil?: true
+
+        # @!attribute direction
+        #   Optional direction filter: outbound for calls placed from your app, inbound for
+        #   calls to one of your numbers
+        #
+        #   @return [String, nil]
+        optional :direction, String, nil?: true
+
+        # @!attribute from
+        #   Only calls started at or after this time (ISO 8601)
+        #
+        #   @return [Time, nil]
+        optional :from, Time, nil?: true
+
+        # @!attribute mode
+        #   Optional mode filter: inapp for calls routed by your number's callback URL,
+        #   agent for calls one of your voice agents answered
+        #
+        #   @return [String, nil]
+        optional :mode, String, nil?: true
+
+        # @!attribute number
+        #   Optional filter on the number that owns the call, one of your voice-enabled
+        #   numbers in E.164 format
+        #
+        #   @return [String, nil]
+        optional :number, String, 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 status
+        #   Optional status filter: initiated, ringing, answered, completed, failed,
+        #   no_answer or rejected
+        #
+        #   @return [String, nil]
+        optional :status, String, nil?: true
+
+        # @!attribute to
+        #   Only calls started at or before this time (ISO 8601)
+        #
+        #   @return [Time, nil]
+        optional :to, Time, nil?: true
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(agent_id: nil, direction: nil, from: nil, mode: nil, number: nil, page: nil, page_size: nil, status: nil, to: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallListParams} for more details.
+        #
+        #   @param agent_id [String, nil] Optional filter on the voice agent that answered the call, such as agent_9f2ab00
+        #
+        #   @param direction [String, nil] Optional direction filter: outbound for calls placed from your app, inbound for
+        #
+        #   @param from [Time, nil] Only calls started at or after this time (ISO 8601)
+        #
+        #   @param mode [String, nil] Optional mode filter: inapp for calls routed by your number's callback URL, agen
+        #
+        #   @param number [String, nil] Optional filter on the number that owns the call, one of your voice-enabled numb
+        #
+        #   @param page [Integer] Page number (1-indexed)
+        #
+        #   @param page_size [Integer] Number of items per page
+        #
+        #   @param status [String, nil] Optional status filter: initiated, ringing, answered, completed, failed, no_answ
+        #
+        #   @param to [Time, nil] Only calls started at or before this time (ISO 8601)
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/call_list_recordings_params.rb

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

data/lib/sentdm/models/voice/call_party.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallParty < Sentdm::Internal::Type::BaseModel
+        # @!attribute kind
+        #   user for one of your app users, number for a phone number, conference for a
+        #   room, anonymous for a caller who withheld their number
+        #
+        #   @return [String, nil]
+        optional :kind, String
+
+        # @!attribute value
+        #   The app user's identity, the phone number in E.164 format, or the room name.
+        #   Null when the kind is anonymous
+        #
+        #   @return [String, nil]
+        optional :value, String, nil?: true
+
+        # @!method initialize(kind: nil, value: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallParty} for more details.
+        #
+        #   One end of a call
+        #
+        #   @param kind [String] user for one of your app users, number for a phone number, conference for a room
+        #
+        #   @param value [String, nil] The app user's identity, the phone number in E.164 format, or the room name. Nul
+      end
+    end
+  end
+end

data/lib/sentdm/models/{calls/participant_update_params.rb → voice/call_record_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#update
-      class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#record
+      class CallRecordParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -13,16 +13,11 @@ module Sentdm
         #   @return [String]
         required :id, String
 
-        # @!attribute participant_id
+        # @!attribute action
+        #   start to begin recording, stop to end it
         #
-        #   @return [String]
-        required :participant_id, String
-
-        # @!attribute muted
-        #   true to mute the participant, false to unmute them
-        #
-        #   @return [Boolean, nil]
-        optional :muted, Sentdm::Internal::Type::Boolean
+        #   @return [String, nil]
+        optional :action, String
 
         # @!attribute sandbox
         #   Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -41,15 +36,13 @@ module Sentdm
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(id:, participant_id:, muted: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        # @!method initialize(id:, action: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Calls::ParticipantUpdateParams} for more details.
+        #   {Sentdm::Models::Voice::CallRecordParams} for more details.
         #
         #   @param id [String]
         #
-        #   @param participant_id [String]
-        #
-        #   @param muted [Boolean] true to mute the participant, false to unmute them
+        #   @param action [String] start to begin recording, stop to end it
         #
         #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
         #

data/lib/sentdm/models/voice/call_recording.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallRecording < Sentdm::Internal::Type::BaseModel
+        # @!attribute download_url
+        #   A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
+        #   can download the recording until it expires
+        #
+        #   @return [String, nil]
+        optional :download_url, String
+
+        # @!attribute recording_id
+        #   The recording's id, the one the call.recording_ready webhook announced it under
+        #
+        #   @return [String, nil]
+        optional :recording_id, String
+
+        # @!attribute url_expires_at
+        #   When the link stops working (UTC). Request the recordings again for a fresh link
+        #
+        #   @return [Time, nil]
+        optional :url_expires_at, Time
+
+        # @!method initialize(download_url: nil, recording_id: nil, url_expires_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallRecording} for more details.
+        #
+        #   A short-lived link to a call recording
+        #
+        #   @param download_url [String] A pre-signed link that downloads the recording as an MP3 file. Anyone holding it
+        #
+        #   @param recording_id [String] The recording's id, the one the call.recording_ready webhook announced it under
+        #
+        #   @param url_expires_at [Time] When the link stops working (UTC). Request the recordings again for a fresh link
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/call_recordings.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallRecordings < Sentdm::Internal::Type::BaseModel
+        # @!attribute recordings
+        #   Every recording of the call, oldest first. Empty until the first
+        #   call.recording_ready webhook has been sent, and for a call that was never
+        #   recorded
+        #
+        #   @return [Array<Sentdm::Models::Voice::CallRecording>, nil]
+        optional :recordings, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::CallRecording] }
+
+        # @!method initialize(recordings: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::CallRecordings} for more details.
+        #
+        #   The recordings of a call, each as a short-lived download link
+        #
+        #   @param recordings [Array<Sentdm::Models::Voice::CallRecording>] Every recording of the call, oldest first. Empty until the first
+        #   call.recording\_
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/call_retrieve_params.rb

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