Class: Revox::Models::AssistantRetrieveResponse::Zoho

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/assistant_retrieve_response.rb,
sig/revox/models/assistant_retrieve_response.rbs

Overview

See Also:

  • Revox::Models::AssistantRetrieveResponse#zoho

Defined Under Namespace

Modules: Outcome Classes: FieldMapping

Instance Attribute Summary collapse

Instance Method Summary collapse

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(source:, zoho_field:) ⇒ Object

Some parameter documentations has been truncated, see FieldMapping for more details.

Parameters:

  • source (String) —

    Source key to read from the call: a structured_output field name, falling back t

  • zoho_field (String) —

    Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company',




# File 'lib/revox/models/assistant_retrieve_response.rb', line 1466

Instance Attribute Details

#connection_id ⇒ String

The Nango connection ID linking the org's Zoho CRM account to Revox.

Parameters:

  • value (String)

Returns:

  • (String) 


1395
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1395

required :connection_id, String

#field_mapping ⇒ Array<Revox::Models::AssistantRetrieveResponse::Zoho::FieldMapping>

Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.

Parameters:

Returns:



1402
1403
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1402

required :field_mapping,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantRetrieveResponse::Zoho::FieldMapping] }

#log_call_activity ⇒ Boolean

When true, also log the call as a record in Zoho's Calls module (related to the upserted prospect via Who_Id).

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


1410
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1410

required :log_call_activity, Revox::Internal::Type::Boolean

#module_ ⇒ String

Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').

Parameters:

  • value (String)

Returns:

  • (String) 


1416
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1416

required :module_, String, api_name: :module

#outcomes ⇒ Array<Symbol, Revox::Models::AssistantRetrieveResponse::Zoho::Outcome>

Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'none' to push when outcome is null.

Parameters:

  • value (::Array[Revox::Models::AssistantRetrieveResponse::Zoho::outcome])

Returns:



1423
1424
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1423

required :outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantRetrieveResponse::Zoho::Outcome] }

#template ⇒ String?

Optional Note body template. Supports {summary}, {outcome}, {phone}, {call_url}, {assistant_name}, {campaign_name}, {transcript}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1433
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1433

optional :template, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1171
 
# File 'sig/revox/models/assistant_retrieve_response.rbs', line 1171

def to_hash: -> {