Class: Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Channel

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Channel

Defined in:

lib/revox/models/campaign_retrieve_response.rb,
sig/revox/models/campaign_retrieve_response.rbs

Instance Attribute Summary

• #id ⇒ String

  The Slack channel ID (e.g. 'C01234567').

• #name ⇒ String^?

  Human-readable Slack channel name, cached for display in the UI and given to the LLM when the agent prompt routes by channel name.

Instance Method Summary

• #initialize(channels:, connection_id:, outcomes:, template: nil) ⇒ Channel constructor

  Some parameter documentations has been truncated, see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack for more details.

• #to_hash ⇒ { id: String, name: String? }

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(channels:, connection_id:, outcomes:, template: nil) ⇒ Channel

Some parameter documentations has been truncated, see Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack for more details.

{{call_

Parameters:

• channels (Array<Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Channel>) —

  The Slack channels eligible to receive the notification. When more than one is c

• connection_id (String) —

  The Nango connection ID linking the org's Slack workspace to Revox.

• outcomes (Array<Symbol, Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Outcome>) —

  Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']).

• template (String, nil) (defaults to: nil) —

  Optional message template. Supports {summary}, {outcome}, {phone},

• id: (String)
• name: (String, nil)

# File 'lib/revox/models/campaign_retrieve_response.rb', line 1335

class Channel < Revox::Internal::Type::BaseModel
  # @!attribute id
  #   The Slack channel ID (e.g. 'C01234567').
  #
  #   @return [String]
  required :id, String

  # @!attribute name
  #   Human-readable Slack channel name, cached for display in the UI and given to the
  #   LLM when the agent prompt routes by channel name.
  #
  #   @return [String, nil]
  optional :name, String, nil?: true

  # @!method initialize(id:, name: nil)
  #   Some parameter documentations has been truncated, see
  #   {Revox::Models::CampaignRetrieveResponse::Campaign::Assistant::Slack::Channel}
  #   for more details.
  #
  #   @param id [String] The Slack channel ID (e.g. 'C01234567').
  #
  #   @param name [String, nil] Human-readable Slack channel name, cached for display in the UI and given to the
end

Instance Attribute Details

#id ⇒ String

The Slack channel ID (e.g. 'C01234567').

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/campaign_retrieve_response.rb', line 1340

required :id, String

#name ⇒ String^?

Human-readable Slack channel name, cached for display in the UI and given to the LLM when the agent prompt routes by channel name.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/revox/models/campaign_retrieve_response.rb', line 1347

optional :name, String, nil?: true

Instance Method Details

#to_hash ⇒ { id: String, name: String? }

Returns:

• ({ id: String, name: String? })

# File 'sig/revox/models/campaign_retrieve_response.rbs', line 1053

def to_hash: -> { id: String, name: String? }