telnyx 5.167.0 → 5.169.0

data/lib/telnyx/models/messaging_outbound_message_payload.rb

@@ -9,6 +9,12 @@ module Telnyx
       #   @return [String, nil]
       optional :id, String
 
+      # @!attribute body
+      #   RCS webhook message body. Text messages use the text property.
+      #
+      #   @return [Telnyx::Models::MessagingOutboundMessagePayload::Body, nil]
+      optional :body, -> { Telnyx::MessagingOutboundMessagePayload::Body }
+
       # @!attribute cc
       #
       #   @return [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>, nil]
@@ -190,12 +196,14 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
+      # @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingOutboundMessagePayload} for more details.
       #
       #   @param id [String] Identifies the type of resource.
       #
+      #   @param body [Telnyx::Models::MessagingOutboundMessagePayload::Body] RCS webhook message body. Text messages use the text property.
+      #
       #   @param cc [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>]
       #
       #   @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
@@ -254,6 +262,20 @@ module Telnyx
       #
       #   @param webhook_url [String, nil] The URL where webhooks related to this message will be sent.
 
+      # @see Telnyx::Models::MessagingOutboundMessagePayload#body
+      class Body < Telnyx::Internal::Type::BaseModel
+        # @!attribute text
+        #   RCS text message.
+        #
+        #   @return [String, nil]
+        optional :text, String
+
+        # @!method initialize(text: nil)
+        #   RCS webhook message body. Text messages use the text property.
+        #
+        #   @param text [String] RCS text message.
+      end
+
       class Cc < Telnyx::Internal::Type::BaseModel
         # @!attribute carrier
         #   The carrier of the receiver.
@@ -415,6 +437,18 @@ module Telnyx
 
       # @see Telnyx::Models::MessagingOutboundMessagePayload#from
       class From < Telnyx::Internal::Type::BaseModel
+        # @!attribute agent_id
+        #   RCS agent identifier.
+        #
+        #   @return [String, nil]
+        optional :agent_id, String
+
+        # @!attribute agent_name
+        #   RCS agent name.
+        #
+        #   @return [String, nil]
+        optional :agent_name, String
+
         # @!attribute carrier
         #   The carrier of the receiver.
         #
@@ -434,10 +468,14 @@ module Telnyx
         #   @return [String, nil]
         optional :phone_number, String
 
-        # @!method initialize(carrier: nil, line_type: nil, phone_number: nil)
+        # @!method initialize(agent_id: nil, agent_name: nil, carrier: nil, line_type: nil, phone_number: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::MessagingOutboundMessagePayload::From} for more details.
         #
+        #   @param agent_id [String] RCS agent identifier.
+        #
+        #   @param agent_name [String] RCS agent name.
+        #
         #   @param carrier [String] The carrier of the receiver.
         #
         #   @param line_type [Symbol, Telnyx::Models::MessagingOutboundMessagePayload::From::LineType] The line-type of the receiver.
@@ -574,6 +612,7 @@ module Telnyx
           DELIVERY_UNCONFIRMED = :delivery_unconfirmed
           DELIVERED = :delivered
           DELIVERY_FAILED = :delivery_failed
+          READ = :read
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -588,6 +627,7 @@ module Telnyx
 
         SMS = :SMS
         MMS = :MMS
+        RCS = :RCS
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/messaging_profile_create_params.rb

@@ -53,6 +53,14 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute features
+      #   Telnyx product features the messaging customer can enable on the messaging
+      #   profile. Keys map to individual feature flags; unknown keys are accepted and
+      #   preserved for forward compatibility with rolling deployments.
+      #
+      #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
+      optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
+
       # @!attribute health_webhook_url
       #   A URL to receive health check webhooks for numbers in this profile.
       #
@@ -133,7 +141,7 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileCreateParams} for more details.
       #
@@ -151,6 +159,8 @@ module Telnyx
       #
       #   @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
       #
+      #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
+      #
       #   @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
       #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.

data/lib/telnyx/models/messaging_profile_features.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class MessagingProfileFeatures < Telnyx::Internal::Type::BaseModel
+      # @!attribute ai_opt_out_detection_enabled
+      #   Enables AI detection of inbound opt-out messages that do not follow the standard
+      #   STOP/UNSTOP/HELP opt-out keyword pattern. When enabled, the messaging platform
+      #   applies an AI model to identify non-standard opt-out requests (e.g.
+      #   natural-language phrases) and treats them as opt-outs.
+      #
+      #   @return [Boolean, nil]
+      optional :ai_opt_out_detection_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!method initialize(ai_opt_out_detection_enabled: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MessagingProfileFeatures} for more details.
+      #
+      #   Telnyx product features the messaging customer can enable on the messaging
+      #   profile. Keys map to individual feature flags; unknown keys are accepted and
+      #   preserved for forward compatibility with rolling deployments.
+      #
+      #   @param ai_opt_out_detection_enabled [Boolean] Enables AI detection of inbound opt-out messages that do not follow the standard
+    end
+  end
+end

data/lib/telnyx/models/messaging_profile_update_params.rb

@@ -44,6 +44,14 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute features
+      #   Telnyx product features the messaging customer can enable on the messaging
+      #   profile. Keys map to individual feature flags; unknown keys are accepted and
+      #   preserved for forward compatibility with rolling deployments.
+      #
+      #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
+      optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
+
       # @!attribute mms_fall_back_to_sms
       #   enables SMS fallback for MMS messages.
       #
@@ -151,7 +159,7 @@ module Telnyx
       #   @return [Array<String>, nil]
       optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
+      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileUpdateParams} for more details.
       #
@@ -167,6 +175,8 @@ module Telnyx
       #
       #   @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
       #
+      #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
+      #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
       #
       #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.

data/lib/telnyx/models/noise_suppression_engine_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::NoiseSuppressionEngines#list
+    class NoiseSuppressionEngineListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/noise_suppression_engine_list_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::NoiseSuppressionEngines#list
+    class NoiseSuppressionEngineListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::NoiseSuppressionEngineListResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::NoiseSuppressionEngineListResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::NoiseSuppressionEngineListResponse::Data>]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute default_attenuation_level
+        #   Default attenuation level of the engine (0-100, in multiples of ten).
+        #
+        #   @return [Integer]
+        required :default_attenuation_level, Integer
+
+        # @!attribute label
+        #   Human-readable name of the engine.
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!attribute value
+        #   Machine-readable identifier of the engine, used when configuring noise
+        #   suppression.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(default_attenuation_level:, label:, value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::NoiseSuppressionEngineListResponse::Data} for more details.
+        #
+        #   A noise suppression engine available to the authenticated user.
+        #
+        #   @param default_attenuation_level [Integer] Default attenuation level of the engine (0-100, in multiples of ten).
+        #
+        #   @param label [String] Human-readable name of the engine.
+        #
+        #   @param value [String] Machine-readable identifier of the engine, used when configuring noise suppressi
+      end
+    end
+  end
+end

data/lib/telnyx/models/number_order_status_update.rb

@@ -28,8 +28,8 @@ module Telnyx
         # @!attribute event_type
         #   The type of event being sent
         #
-        #   @return [String]
-        required :event_type, String
+        #   @return [Symbol, Telnyx::Models::NumberOrderStatusUpdate::Data::EventType]
+        required :event_type, enum: -> { Telnyx::NumberOrderStatusUpdate::Data::EventType }
 
         # @!attribute occurred_at
         #   ISO 8601 timestamp of when the event occurred
@@ -51,13 +51,25 @@ module Telnyx
         # @!method initialize(id:, event_type:, occurred_at:, payload:, record_type:)
         #   @param id [String] Unique identifier for the event
         #
-        #   @param event_type [String] The type of event being sent
+        #   @param event_type [Symbol, Telnyx::Models::NumberOrderStatusUpdate::Data::EventType] The type of event being sent
         #
         #   @param occurred_at [Time] ISO 8601 timestamp of when the event occurred
         #
         #   @param payload [Telnyx::Models::NumberOrderWithPhoneNumbers]
         #
         #   @param record_type [String] Type of record
+
+        # The type of event being sent
+        #
+        # @see Telnyx::Models::NumberOrderStatusUpdate::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          NUMBER_ORDER_COMPLETE = :"number_order.complete"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # @see Telnyx::Models::NumberOrderStatusUpdate#meta

data/lib/telnyx/models/number_order_status_update_webhook_event.rb

@@ -28,8 +28,8 @@ module Telnyx
         # @!attribute event_type
         #   The type of event being sent
         #
-        #   @return [String]
-        required :event_type, String
+        #   @return [Symbol, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data::EventType]
+        required :event_type, enum: -> { Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType }
 
         # @!attribute occurred_at
         #   ISO 8601 timestamp of when the event occurred
@@ -56,7 +56,7 @@ module Telnyx
         #
         #   @param id [String] Unique identifier for the event
         #
-        #   @param event_type [String] The type of event being sent
+        #   @param event_type [Symbol, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data::EventType] The type of event being sent
         #
         #   @param occurred_at [Time] ISO 8601 timestamp of when the event occurred
         #
@@ -64,6 +64,18 @@ module Telnyx
         #
         #   @param record_type [String] Type of record
 
+        # The type of event being sent
+        #
+        # @see Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          NUMBER_ORDER_COMPLETE = :"number_order.complete"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see Telnyx::Models::NumberOrderStatusUpdateWebhookEvent::Data#payload
         class Payload < Telnyx::Internal::Type::BaseModel
           # @!attribute id

data/lib/telnyx/models/outbound_message.rb

@@ -51,6 +51,7 @@ module Telnyx
 
         MESSAGE_SENT = :"message.sent"
         MESSAGE_FINALIZED = :"message.finalized"
+        MESSAGE_READ = :"message.read"
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/outbound_message_payload.rb

@@ -9,6 +9,12 @@ module Telnyx
       #   @return [String, nil]
       optional :id, String
 
+      # @!attribute body
+      #   RCS webhook message body. Text messages use the text property.
+      #
+      #   @return [Telnyx::Models::OutboundMessagePayload::Body, nil]
+      optional :body, -> { Telnyx::OutboundMessagePayload::Body }
+
       # @!attribute cc
       #
       #   @return [Array<Telnyx::Models::OutboundMessagePayload::Cc>, nil]
@@ -48,8 +54,8 @@ module Telnyx
       #   These errors may point at addressees when referring to unsuccessful/unconfirmed
       #   delivery statuses.
       #
-      #   @return [Array<Telnyx::Models::MessagingError>, nil]
-      optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingError] }
+      #   @return [Array<Telnyx::Models::MessagingError0b38e7044b>, nil]
+      optional :errors, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingError0b38e7044b] }
 
       # @!attribute from
       #
@@ -190,12 +196,14 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(id: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
+      # @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::OutboundMessagePayload} for more details.
       #
       #   @param id [String] Identifies the type of resource.
       #
+      #   @param body [Telnyx::Models::OutboundMessagePayload::Body] RCS webhook message body. Text messages use the text property.
+      #
       #   @param cc [Array<Telnyx::Models::OutboundMessagePayload::Cc>]
       #
       #   @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
@@ -208,7 +216,7 @@ module Telnyx
       #
       #   @param encoding [String] Encoding scheme used for the message body.
       #
-      #   @param errors [Array<Telnyx::Models::MessagingError>] These errors may point at addressees when referring to unsuccessful/unconfirmed
+      #   @param errors [Array<Telnyx::Models::MessagingError0b38e7044b>] These errors may point at addressees when referring to unsuccessful/unconfirmed
       #
       #   @param from [Telnyx::Models::OutboundMessagePayload::From]
       #
@@ -254,6 +262,20 @@ module Telnyx
       #
       #   @param webhook_url [String, nil] The URL where webhooks related to this message will be sent.
 
+      # @see Telnyx::Models::OutboundMessagePayload#body
+      class Body < Telnyx::Internal::Type::BaseModel
+        # @!attribute text
+        #   RCS text message.
+        #
+        #   @return [String, nil]
+        optional :text, String
+
+        # @!method initialize(text: nil)
+        #   RCS webhook message body. Text messages use the text property.
+        #
+        #   @param text [String] RCS text message.
+      end
+
       class Cc < Telnyx::Internal::Type::BaseModel
         # @!attribute carrier
         #   The carrier of the receiver.
@@ -415,6 +437,18 @@ module Telnyx
 
       # @see Telnyx::Models::OutboundMessagePayload#from
       class From < Telnyx::Internal::Type::BaseModel
+        # @!attribute agent_id
+        #   RCS agent identifier.
+        #
+        #   @return [String, nil]
+        optional :agent_id, String
+
+        # @!attribute agent_name
+        #   RCS agent name.
+        #
+        #   @return [String, nil]
+        optional :agent_name, String
+
         # @!attribute carrier
         #   The carrier of the receiver.
         #
@@ -434,10 +468,14 @@ module Telnyx
         #   @return [String, nil]
         optional :phone_number, String
 
-        # @!method initialize(carrier: nil, line_type: nil, phone_number: nil)
+        # @!method initialize(agent_id: nil, agent_name: nil, carrier: nil, line_type: nil, phone_number: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::OutboundMessagePayload::From} for more details.
         #
+        #   @param agent_id [String] RCS agent identifier.
+        #
+        #   @param agent_name [String] RCS agent name.
+        #
         #   @param carrier [String] The carrier of the receiver.
         #
         #   @param line_type [Symbol, Telnyx::Models::OutboundMessagePayload::From::LineType] The line-type of the receiver.
@@ -574,6 +612,7 @@ module Telnyx
           DELIVERY_UNCONFIRMED = :delivery_unconfirmed
           DELIVERED = :delivered
           DELIVERY_FAILED = :delivery_failed
+          READ = :read
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -588,6 +627,7 @@ module Telnyx
 
         SMS = :SMS
         MMS = :MMS
+        RCS = :RCS
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb

@@ -159,6 +159,7 @@ module Telnyx
         SPEECHMATICS_STANDARD = :"speechmatics/standard"
         SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
         NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
+        OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
         HUMAIN_REALTIME = :"humain/realtime"
         RESON8_TURNS = :"reson8/turns"
         COHERE_AR_STT = :"cohere/ar-stt"

data/lib/telnyx/models/success_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BotSignup#create
+    class SuccessResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute message
+      #   Human-readable status message.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute success
+      #   Whether the request was accepted.
+      #
+      #   @return [Boolean]
+      required :success, Telnyx::Internal::Type::Boolean
+
+      # @!method initialize(message:, success:)
+      #   Status envelope used by the signup and magic-link flows.
+      #
+      #   @param message [String] Human-readable status message.
+      #
+      #   @param success [Boolean] Whether the request was accepted.
+    end
+  end
+end