Class: Zavudev::Models::Senders::Agent::ToolCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/senders/agent/tool_create_params.rb,
sig/zavudev/models/senders/agent/tool_create_params.rbs

Overview

See Also:

  • Zavudev::Resources::Senders::Agent::Tools#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(sender_id:, description:, name:, parameters:, webhook_url:, enabled: nil, webhook_secret: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Senders::Agent::ToolCreateParams for more details.

Parameters:

  • sender_id (String)
  • description (String)
  • name (String)
  • parameters (Zavudev::Models::Senders::Agent::ToolParameters)
  • webhook_url (String) —

    Must be HTTPS.

  • enabled (Boolean) (defaults to: nil)
  • webhook_secret (String) (defaults to: nil) —

    Signing secret for the webhook. Optional: Zavu generates one when omitted and re

  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 51

Instance Attribute Details

#description ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 20

required :description, String

#enabled ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


41
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 41

optional :enabled, Zavudev::Internal::Type::Boolean

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 25

required :name, String

#parameters ⇒ Zavudev::Models::Senders::Agent::ToolParameters

Parameters:

  • value (Zavudev::Senders::Agent::ToolParameters)

Returns:



30
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 30

required :parameters, -> { Zavudev::Senders::Agent::ToolParameters }

#sender_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 15

required :sender_id, String

#webhook_secret ⇒ String?

Signing secret for the webhook. Optional: Zavu generates one when omitted and returns it on this response only. Supply your own if you already have a secret you want reused.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 49

optional :webhook_secret, String, api_name: :webhookSecret

#webhook_url ⇒ String

Must be HTTPS.

Parameters:

  • value (String)

Returns:

  • (String) 


36
 
# File 'lib/zavudev/models/senders/agent/tool_create_params.rb', line 36

required :webhook_url, String, api_name: :webhookUrl

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/zavudev/models/senders/agent/tool_create_params.rbs', line 50

def to_hash: -> {