sentdm 0.39.0 → 0.40.0

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#rotate_secret
+      class AgentRotateSecretParams < 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
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#update
+      class AgentUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute audio
+        #   Audio sessions: { sample_rate }; null restores the default.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil]
+        optional :audio, -> { Sentdm::Voice::VoiceAgentAudioSpec }, nil?: true
+
+        # @!attribute fallback
+        #   A new fallback party, or null for none.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentPartySpec, nil]
+        optional :fallback, -> { Sentdm::Voice::VoiceAgentPartySpec }, nil?: true
+
+        # @!attribute greeting
+        #   A new greeting, or null for none.
+        #
+        #   @return [String, nil]
+        optional :greeting, String, nil?: true
+
+        # @!attribute limits
+        #   The whole limits object; null restores the defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil]
+        optional :limits, -> { Sentdm::Voice::VoiceAgentLimitsSpec }, nil?: true
+
+        # @!attribute name
+        #   A new name, 1 to 100 characters.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute session_type
+        #   text or audio. Changing it drops the settings the other type cannot have
+        #   (speech, audio, greeting) unless the body sends them.
+        #
+        #   @return [String, nil]
+        optional :session_type, String
+
+        # @!attribute speech
+        #   Text sessions: { setting, voice, language }, replaced whole; null restores the
+        #   defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil]
+        optional :speech, -> { Sentdm::Voice::VoiceAgentSpeechSpec }, nil?: true
+
+        # @!attribute tools
+        #   The whole list of tools; null restores the default.
+        #
+        #   @return [Array<String>, nil]
+        optional :tools, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute transcripts
+        #   The whole transcripts object; null restores the defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil]
+        optional :transcripts, -> { Sentdm::Voice::VoiceAgentTranscriptsSpec }, nil?: true
+
+        # @!attribute transfer_targets
+        #   The whole list of parties; null clears it.
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil]
+        optional :transfer_targets,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceAgentPartySpec] },
+                 nil?: true
+
+        # @!attribute websocket_url
+        #   A new wss:// URL, or null for an agent that dials in.
+        #
+        #   @return [String, nil]
+        optional :websocket_url, String, nil?: true
+
+        # @!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:, audio: nil, fallback: nil, greeting: nil, limits: nil, name: nil, sandbox: nil, session_type: nil, speech: nil, tools: nil, transcripts: nil, transfer_targets: nil, websocket_url: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::AgentUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param audio [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil] Audio sessions: { sample_rate }; null restores the default.
+        #
+        #   @param fallback [Sentdm::Models::Voice::VoiceAgentPartySpec, nil] A new fallback party, or null for none.
+        #
+        #   @param greeting [String, nil] A new greeting, or null for none.
+        #
+        #   @param limits [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil] The whole limits object; null restores the defaults.
+        #
+        #   @param name [String] A new name, 1 to 100 characters.
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param session_type [String] text or audio. Changing it drops the settings the other type cannot have (speech
+        #
+        #   @param speech [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil] Text sessions: { setting, voice, language }, replaced whole; null restores the d
+        #
+        #   @param tools [Array<String>, nil] The whole list of tools; null restores the default.
+        #
+        #   @param transcripts [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil] The whole transcripts object; null restores the defaults.
+        #
+        #   @param transfer_targets [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil] The whole list of parties; null clears it.
+        #
+        #   @param websocket_url [String, nil] A new wss:// URL, or null for an agent that dials in.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#create
+      class APIResponseOfVoiceAgent < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A voice agent as stored: what was written with every default filled in, plus the
+        #   signing secret the one time it is shown (on create, and on rotate). The one
+        #   shape every read of an agent answers with, on /v3/voice/agents and on the admin
+        #   API the dashboard uses, so the two cannot drift.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgent, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgent }, 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::APIResponseOfVoiceAgent} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceAgent, nil] A voice agent as stored: what was written with every default filled in, plus the
+        #
+        #   @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/voice/api_response_of_voice_agent_secret.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#rotate_secret
+      class APIResponseOfVoiceAgentSecret < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A freshly rotated signing secret.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSecret, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgentSecret }, 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)
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceAgentSecret, nil] A freshly rotated signing secret.
+        #
+        #   @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/voice/api_response_of_voice_agents_list.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceAgentsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+        #   with the admin API.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentsList, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgentsList }, 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::APIResponseOfVoiceAgentsList} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceAgentsList, nil] A page of the account's agents. The agent itself is VoiceAgentResponse, shared 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/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/voice/call.rb

@@ -12,6 +12,13 @@ module Sentdm
         #   @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
@@ -19,6 +26,22 @@ module Sentdm
         #   @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
@@ -40,9 +63,9 @@ module Sentdm
 
         # @!attribute failure_reason
         #   Why the call did not complete: callback_timeout, invalid_answer,
-        #   insufficient_balance, destination_blocked, callback_not_configured, rejected or
-        #   no_answer. Null while the call is live, when it completed, and when it failed
-        #   without a recorded reason
+        #   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
@@ -53,9 +76,19 @@ module Sentdm
         #   @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
+        #   routed by your number's callback URL; agent for a call one of your voice agents
+        #   answered
         #
         #   @return [String, nil]
         optional :mode, String
@@ -108,7 +141,7 @@ module Sentdm
         #   @return [Sentdm::Models::Voice::CallParty, nil]
         optional :to, -> { Sentdm::Voice::CallParty }
 
-        # @!method initialize(id: nil, answered_at: nil, direction: nil, duration_seconds: nil, ended_at: nil, failure_reason: nil, from: nil, mode: nil, number: nil, price: nil, recording_available: nil, started_at: nil, status: nil, timeline: nil, to: nil)
+        # @!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.
         #
@@ -116,8 +149,14 @@ module Sentdm
         #
         #   @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
@@ -128,6 +167,8 @@ module Sentdm
         #
         #   @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
@@ -143,6 +184,57 @@ module Sentdm
         #   @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

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

@@ -8,6 +8,13 @@ module Sentdm
         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
@@ -21,6 +28,13 @@ module Sentdm
         #   @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
@@ -58,14 +72,18 @@ module Sentdm
         #   @return [String, nil]
         optional :x_profile_id, String
 
-        # @!method initialize(direction: nil, from: nil, number: nil, page: nil, page_size: nil, status: nil, to: nil, x_profile_id: nil, request_options: {})
+        # @!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)

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

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